@@ -14,27 +14,33 @@ Key features:
14
14
15
15
## Installation
16
16
17
+ You can install the package directly from PyPI:
18
+
17
19
``` bash
18
- # Clone the repository
19
- git clone https://github.com/yourusername/camel-toolkits-mcp.git
20
- cd camel-toolkits-mcp
20
+ pip install camel-toolkits-mcp
21
+ ```
21
22
22
- # Install dependencies
23
- pip install -r requirements.txt
23
+ Or install from source:
24
+
25
+ ``` bash
26
+ git clone https://github.com/jinx0a/camel-toolkits-mcp.git
27
+ cd camel-toolkits-mcp
28
+ pip install -e .
24
29
```
25
30
26
31
## Usage
27
32
28
- ### Starting the Server
33
+ Start the server:
29
34
30
35
``` bash
31
- python server.py
36
+ python -m camel_toolkits_mcp
32
37
```
33
38
34
- This will start the MCP server, which exposes two main tools:
39
+ This will start an MCP server that exposes the following tools:
35
40
36
- 1 . ` get_toolkits() ` - Lists all available toolkits in the Camel framework
37
- 2 . ` register_toolkit(toolkit_name, api_keys) ` - Loads a specific toolkit and registers its tools
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
38
44
39
45
### Example: Using Notion Toolkit
40
46
@@ -86,9 +92,32 @@ For toolkits requiring API keys (like Notion, OpenAI, etc.), you can provide the
86
92
1 . Set in environment variables before starting the server
87
93
2 . Provide them directly when calling ` register_toolkit `
88
94
95
+ ## Development
96
+
97
+ To set up a development environment:
98
+
99
+ ``` bash
100
+ pip install -e " .[dev]"
101
+ ```
102
+
103
+ Run tests:
104
+
105
+ ``` bash
106
+ pytest
107
+ ```
108
+
89
109
## Contributing
90
110
91
- Contributions are welcome! Please feel free to submit a Pull Request.
111
+ Contributions are welcome! The project uses GitHub Actions for CI/CD:
112
+
113
+ 1 . Tests are run automatically on pull requests
114
+ 2 . New releases are automatically published to PyPI when a GitHub release is created
115
+
116
+ To publish a new version:
117
+
118
+ 1 . Update the version in ` camel_toolkits_mcp/__init__.py `
119
+ 2 . Create a new GitHub release with a tag like ` v0.1.0 `
120
+ 3 . The GitHub workflow will automatically build and publish to PyPI
92
121
93
122
## License
94
123
0 commit comments