Skip to content

Commit 450a7f2

Browse files
committed
Added missing details about the services that require keys and/or authentication
1 parent 1d2cbaf commit 450a7f2

File tree

3 files changed

+3
-1
lines changed

3 files changed

+3
-1
lines changed

docker-compose.yml

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ services:
4747
VALKEY_HOST: valkey
4848
VALKEY_PORT: 6379
4949
VALKEY_TIMEOUT: 10
50+
# TAVILY_API_KEY: include-you-api-key-here
5051
ports:
5152
- "9006:9000"
5253

docs/usage.md

+1
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,7 @@ The following tools services can be made available using Wanaku and used to prov
272272
| `kafka` | wanaku-routing-kafka-service | Provides access to Kafka topics as tools via Wanaku |
273273
| `tavily` | wanaku-routing-tavily-service | Provides search capabilities on the Web using [Tavily](https://tavily.com/) |
274274

275+
NOTE: some services (i.e.; Tavily, S3, etc.) may require API keys and/or other forms of authentication. Check the README.md files in each service documentation for more details.
275276

276277
## Adding Your Own Resource Provider or Tool Service
277278

services/tools/wanaku-routing-tavily-service/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A service that searches on the Web using [Tavily](https://tavily.com/).
55
To run set your API key using either one of:
66

77
- the environment variable `TAVILY_API_KEY`
8-
- the `tavily.api.key` property when running the application (i.e.: `-Dtavily.api.key=my-key`)
8+
- the `tavily.api.key` property when running the application (i.e.,: `-Dtavily.api.key=my-key`)
99

1010
```shell
1111
wanaku tools add -n "tavily-search" --description "Search on the internet using Tavily" --uri "tavily://search?maxResults={maxResults}" --type tavily --property "_body:string,The search terms" --property "maxResults:int,The maxResults is the expected number of results to be found if the search request were made" --required "_body"

0 commit comments

Comments
 (0)