Skip to content

Commit

Permalink
docs: add instructions of how to set up external tools
Browse files Browse the repository at this point in the history
  • Loading branch information
dongyuanjushi committed May 11, 2024
1 parent 2b5a4e9 commit abde8cf
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,8 @@ $ pip install -e .
```

### 1.2 Usage
If you use external tool APIs in your agents, you need to set up your API keys as follows:
```bash
export RAPID_API_KEY=""
export WOLFRAM_ALPHA_APPID=""
```
If you use external tool APIs in your agents, you can follow instructions of setting up tools in [How to setup external tools](./tools.md).

You can also create .env file from the .env.example file, and then use dotenv to load the environment variables using .env file into your application's environment at runtime.

```bash
Expand Down
25 changes: 25 additions & 0 deletions tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Tool Configuration
## Available tools

### Wolfram Alpha
1. Register wolfram alpha app account and activate [APP ID](https://developer.wolframalpha.com/access)
2. Setup Wolfram Alpha APP_ID
```bash
export WOLFRAM_ALPHA_APPID=<YOUR_APP_ID>
```

### Rapid API Tool
1. Register for [Rapid API](https://rapidapi.com/hub)
2. Click into the tool page that you want to call and click the (`Subscribe to Test`) button to activate tools.
3. Setup up Rapid API Key
```bash
export RAPID_API_KEY=<YOUR_RAPID_API_KEY>
```
#### Current supported Rapid API tools
- [Words API](https://rapidapi.com/dpventures/api/wordsapi/)
- [Moon Phase](https://rapidapi.com/MoonAPIcom/api/moon-phase/)
- [Trip Advisor](https://rapidapi.com/DataCrawler/api/tripadvisor16)
- [Shazam](https://rapidapi.com/apidojo/api/shazam/)
- [IMDB](https://rapidapi.com/rapihub-rapihub-default/api/imdb-top-100-movies/)


0 comments on commit abde8cf

Please sign in to comment.