Skip to content

Commit 3816f8e

Browse files
committed
update README.md
1 parent 25ffaf3 commit 3816f8e

File tree

1 file changed

+27
-44
lines changed

1 file changed

+27
-44
lines changed

README.md

Lines changed: 27 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ This project bridges the gap between the Camel AI framework's toolkit ecosystem
88

99
Key features:
1010
- Dynamically discover and list available Camel toolkits
11-
- Load and register toolkits at runtime with a simple API
12-
- Automatic detection and handling of required API keys
11+
- Load and execute toolkit functions at runtime
1312
- Seamless conversion of Camel toolkit functions to MCP-compatible tools
1413

1514
## Installation
@@ -28,23 +27,11 @@ cd camel-toolkits-mcp
2827
pip install -e .
2928
```
3029

31-
## Usage
30+
## Config with MCP clients
3231

33-
Start the server:
32+
### Using with uvx
3433

35-
```bash
36-
python -m camel_toolkits_mcp
37-
```
38-
39-
This will start an MCP server that exposes the following tools:
40-
41-
- `get_toolkits_list()`: Lists all available Camel toolkits
42-
- `register_toolkit()`: Registers a toolkit by name
43-
- `get_toolkit_info()`: Gets information about a toolkit's parameters
44-
45-
### Using with UVX
46-
47-
You can easily configure UVX to run the Camel toolkits server in your `.uvx.json` file:
34+
You can easily configure uvx to run the Camel toolkits server like this:
4835

4936
```json
5037
{
@@ -56,40 +43,39 @@ You can easily configure UVX to run the Camel toolkits server in your `.uvx.json
5643
],
5744
"env": {
5845
"OPENAI_API_KEY": "your-openai-key",
59-
"NOTION_TOKEN": "your-notion-token"
46+
"NOTION_TOKEN": "your-notion-token",
47+
"..." : "..."
6048
}
6149
}
6250
}
6351
}
6452
```
6553

66-
This configuration will automatically launch the Camel toolkits server when starting UVX.
54+
## Available Tools
55+
56+
The server exposes the following MCP-compatible tools:
57+
58+
- `get_toolkits_list()`: Lists all available Camel toolkits with their descriptions
59+
- `list_toolkit_functions(toolkit_name, include_methods=True)`: Lists all functions available in a specific toolkit
60+
- `execute_toolkit_function(toolkit_name, function_name, toolkit_params=None, function_args=None)`: Executes a specific function from a toolkit
6761

68-
### Example: Using Notion Toolkit
62+
### Example: Using Tools
6963

7064
```python
7165
# First, discover available toolkits
72-
toolkits = get_toolkits()
73-
print(toolkits) # Shows all available toolkits including NotionToolkit
74-
75-
# Register the Notion toolkit
76-
result = register_toolkit("NotionToolkit")
77-
78-
# If API keys are required, you'll get a response like:
79-
# {
80-
# "status": "missing_api_keys",
81-
# "toolkit": "NotionToolkit",
82-
# "missing_keys": ["NOTION_TOKEN"],
83-
# "message": "Missing required API keys: NOTION_TOKEN. Please provide these keys to register the toolkit."
84-
# }
85-
86-
# Register with API keys:
87-
result = register_toolkit(
88-
"NotionToolkit",
89-
api_keys={"NOTION_TOKEN": "your_notion_api_key"}
66+
toolkits = get_toolkits_list()
67+
print(toolkits) # Shows all available toolkits
68+
69+
# List functions in a specific toolkit (e.g., NotionToolkit)
70+
functions = list_toolkit_functions(toolkit_name="NotionToolkit")
71+
72+
# Execute a toolkit function
73+
result = execute_toolkit_function(
74+
toolkit_name="NotionToolkit",
75+
function_name="search_pages",
76+
toolkit_params={"notion_token": "your-notion-token"},
77+
function_args={"query": "meeting notes"}
9078
)
91-
92-
# Now all Notion toolkit tools are available for use through MCP
9379
```
9480

9581
## Architecture
@@ -110,10 +96,7 @@ This server supports all toolkits in the Camel framework, including:
11096

11197
## API Key Management
11298

113-
For toolkits requiring API keys (like Notion, OpenAI, etc.), you can provide them in two ways:
114-
115-
1. Set in environment variables before starting the server
116-
2. Provide them directly when calling `register_toolkit`
99+
For toolkits requiring API keys (like Notion, OpenAI, etc.), you should provide them in the environment variables when configuring the MCP server.
117100

118101
## Development
119102

0 commit comments

Comments
 (0)