zoo_mcp 0.9.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- zoo_mcp/__init__.py +77 -0
- zoo_mcp/__main__.py +15 -0
- zoo_mcp/ai_tools.py +256 -0
- zoo_mcp/kcl_docs.py +268 -0
- zoo_mcp/kcl_samples.py +313 -0
- zoo_mcp/server.py +760 -0
- zoo_mcp/utils/__init__.py +0 -0
- zoo_mcp/utils/image_utils.py +100 -0
- zoo_mcp/zoo_tools.py +1179 -0
- zoo_mcp-0.9.2.dist-info/METADATA +154 -0
- zoo_mcp-0.9.2.dist-info/RECORD +14 -0
- zoo_mcp-0.9.2.dist-info/WHEEL +4 -0
- zoo_mcp-0.9.2.dist-info/entry_points.txt +3 -0
- zoo_mcp-0.9.2.dist-info/licenses/LICENSE +21 -0
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: zoo_mcp
|
|
3
|
+
Version: 0.9.2
|
|
4
|
+
Summary: An MCP server utilizing Zoo's various tools
|
|
5
|
+
Keywords: zoo,mcp,kittycad,3d,modeling,server
|
|
6
|
+
Author: Ryan Barton
|
|
7
|
+
Author-email: Ryan Barton <ryan@zoo.dev>
|
|
8
|
+
License-Expression: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Topic :: Software Development
|
|
13
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Requires-Dist: aiofiles~=25.1
|
|
19
|
+
Requires-Dist: kittycad<=2.0
|
|
20
|
+
Requires-Dist: mcp[cli]>1.23.0,<2.0
|
|
21
|
+
Requires-Dist: pillow>=11.3,<13.0
|
|
22
|
+
Requires-Dist: truststore~=0.10
|
|
23
|
+
Requires-Dist: zoo-kcl>=0.3.117
|
|
24
|
+
Maintainer: Ryan Barton
|
|
25
|
+
Maintainer-email: Ryan Barton <ryan@zoo.dev>
|
|
26
|
+
Requires-Python: >=3.11, <3.14
|
|
27
|
+
Project-URL: Repository, https://github.com/KittyCAD/zoo-mcp
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
|
|
30
|
+
# Zoo Model Context Protocol (MCP) Server
|
|
31
|
+
|
|
32
|
+
An [MCP server](https://modelcontextprotocol.io/docs/getting-started/intro) housing various Zoo built utilities
|
|
33
|
+
|
|
34
|
+
<!-- mcp-name: io.github.KittyCAD/zoo-mcp -->
|
|
35
|
+
|
|
36
|
+
## Prerequisites
|
|
37
|
+
|
|
38
|
+
1. An API key for Zoo, get one [here](https://zoo.dev/account)
|
|
39
|
+
2. An environment variable `ZOO_API_TOKEN` set to your API key
|
|
40
|
+
```bash
|
|
41
|
+
export ZOO_API_TOKEN="your_api_key_here"
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Installation
|
|
45
|
+
|
|
46
|
+
1. [Ensure uv has been installed](https://docs.astral.sh/uv/getting-started/installation/)
|
|
47
|
+
|
|
48
|
+
2. [Create a uv environment](https://docs.astral.sh/uv/pip/environments/)
|
|
49
|
+
```bash
|
|
50
|
+
uv venv
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
3. [Activate your uv environment (Optional)](https://docs.astral.sh/uv/pip/environments/#using-a-virtual-environment)
|
|
54
|
+
|
|
55
|
+
4. Install the package from GitHub
|
|
56
|
+
```bash
|
|
57
|
+
uv pip install git+ssh://git@github.com/KittyCAD/zoo-mcp.git
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Running the Server
|
|
61
|
+
|
|
62
|
+
The server can be started by using [uvx](https://docs.astral.sh/uv/guides/tools/#running-tools)
|
|
63
|
+
```bash
|
|
64
|
+
uvx zoo-mcp
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
The server can be started locally by using uv and the zoo_mcp module
|
|
68
|
+
```bash
|
|
69
|
+
uv run -m zoo_mcp
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
The server can also be run with the [mcp package](https://github.com/modelcontextprotocol/python-sdk)
|
|
73
|
+
```bash
|
|
74
|
+
uv run mcp run src/zoo_mcp/server.py
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Integrations
|
|
78
|
+
|
|
79
|
+
The server can be used as is by [running the server](#running-the-server) or importing directly into your python code.
|
|
80
|
+
```python
|
|
81
|
+
from zoo_mcp.server import mcp
|
|
82
|
+
|
|
83
|
+
mcp.run()
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Individual tools can be used in your own python code as well
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
from mcp.server.fastmcp import FastMCP
|
|
90
|
+
from zoo_mcp.ai_tools import text_to_cad
|
|
91
|
+
|
|
92
|
+
mcp = FastMCP(name="My Example Server")
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
@mcp.tool()
|
|
96
|
+
async def my_text_text_to_cad(prompt: str) -> str:
|
|
97
|
+
"""
|
|
98
|
+
Example tool that uses the text_to_cad function from zoo_mcp.tools
|
|
99
|
+
"""
|
|
100
|
+
return await text_to_cad(prompt=prompt)
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
The server can be integrated with [Claude desktop](https://claude.ai/download) using the following command
|
|
104
|
+
```bash
|
|
105
|
+
uv run mcp install src/zoo_mcp/server.py
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
The server can also be integrated with [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview) using the following command
|
|
109
|
+
```bash
|
|
110
|
+
claude mcp add --scope project "Zoo-MCP" uv -- --directory "$PWD"/src/zoo_mcp run server.py
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
The server can also be tested using the [MCP Inspector](https://modelcontextprotocol.io/legacy/tools/inspector#python)
|
|
114
|
+
```bash
|
|
115
|
+
uv run mcp dev src/zoo_mcp/server.py
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
For running with [codex-cli](https://github.com/openai/codex)
|
|
119
|
+
```bash
|
|
120
|
+
codex \
|
|
121
|
+
-c 'mcp_servers.zoo.command="uvx"' \
|
|
122
|
+
-c 'mcp_servers.zoo.args=["zoo-mcp"]' \
|
|
123
|
+
-c mcp_servers.zoo.env.ZOO_API_TOKEN="$ZOO_API_TOKEN"
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
You can also use the helper script included in this repo:
|
|
127
|
+
```bash
|
|
128
|
+
./codex-zoo.sh
|
|
129
|
+
```
|
|
130
|
+
The script prompts for a request, runs Codex with the Zoo MCP server, and saves a JSONL transcript (including token usage) to `codex-run-<timestamp>.jsonl`.
|
|
131
|
+
|
|
132
|
+
## Contributing
|
|
133
|
+
|
|
134
|
+
Contributions are welcome! Please open an issue or submit a pull request on the [GitHub repository](https://github.com/KittyCAD/zoo-mcp)
|
|
135
|
+
|
|
136
|
+
PRs will need to pass tests and linting before being merged.
|
|
137
|
+
|
|
138
|
+
### [ruff](https://docs.astral.sh/ruff/) is used for linting and formatting.
|
|
139
|
+
```bash
|
|
140
|
+
uvx ruff check
|
|
141
|
+
uvx ruff format
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### [ty](https://docs.astral.sh/ty/) is used for type checking.
|
|
145
|
+
```bash
|
|
146
|
+
uvx ty check
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
## Testing
|
|
150
|
+
|
|
151
|
+
The server includes tests located in [`tests`](`tests`). To run the tests, use the following command:
|
|
152
|
+
```bash
|
|
153
|
+
uv run pytest -n auto
|
|
154
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
zoo_mcp/__init__.py,sha256=ioSZucv__T4P7DJHUqRXbpGu_FyKJ340txRhK-NS8PE,2316
|
|
2
|
+
zoo_mcp/__main__.py,sha256=xpPLf-1b_vqPxu1MpDD1F100VQ6tlVy8V-knr3zbmOY,380
|
|
3
|
+
zoo_mcp/ai_tools.py,sha256=E9AmrZGdIcY5tZccjAIs_ptpWte3c6UjIBqzlpU-XZ4,10603
|
|
4
|
+
zoo_mcp/kcl_docs.py,sha256=PEuzn2JzBVdyt3Kd1yzR0e5w-2ZKRT3M3YINt_XU70I,8633
|
|
5
|
+
zoo_mcp/kcl_samples.py,sha256=3YL4Z168M3hF7EofMrs9trxFbBqMgMCHUpKNllWQxKw,10228
|
|
6
|
+
zoo_mcp/server.py,sha256=GQ3b86_lf6IQ8eE-VRf1O1d2UdW7nMN5NY3-ufbsfcw,32113
|
|
7
|
+
zoo_mcp/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
8
|
+
zoo_mcp/utils/image_utils.py,sha256=VZEvZgHRdgO__xIG-YfsA_guLaOI91HzICRKj8XPUww,2816
|
|
9
|
+
zoo_mcp/zoo_tools.py,sha256=m4Fn7joqtYT4KP3r-QLm1c-9ilIvISpMh63sy_2fgq0,43373
|
|
10
|
+
zoo_mcp-0.9.2.dist-info/licenses/LICENSE,sha256=-49Z0mKREsT7vQloQJOFT9VUdxvTIhvXhT0S3E90gks,1060
|
|
11
|
+
zoo_mcp-0.9.2.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
|
|
12
|
+
zoo_mcp-0.9.2.dist-info/entry_points.txt,sha256=JhmRyIycFN2Akep_1yGhQq6bzIydJclJHunz6jateW4,49
|
|
13
|
+
zoo_mcp-0.9.2.dist-info/METADATA,sha256=vsssKRYe0Bns5jO03EnuNXnmfJ0Vnd1uR-U3xFSIFB8,4518
|
|
14
|
+
zoo_mcp-0.9.2.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Zoo
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|