✨ 核心功能
- 🚀 基于 fastmcp 的高性能实现
- 🛠 完整的 CRUD 操作工具集
- 🖼 专用的缩略图下载/上传工具
- 🔄 高效的连接池管理
- ✅ 使用 pytest 进行全面的测试覆盖
- 📦 使用 UV 进行依赖管理
- 🌐 跨平台支持(Windows、macOS、Linux)
🚀 使用场景
- 在 ShotGrid 平台上进行实体管理
- 自动化处理 ShotGrid 数据
- 开发与 ShotGrid 集成的应用程序
🔧 可用工具
create
: 创建 ShotGrid 实体read
: 读取实体信息update
: 更新实体数据delete
: 删除实体download_thumbnail
: 下载实体缩略图upload_thumbnail
: 上传实体缩略图
🚀 快速开始
安装
使用 UV 安装:
bash
uv pip install shotgrid-mcp-server
开发设置
-
克隆仓库:
bash
git clone https://github.com/loonghao/shotgrid-mcp-server.git
cd shotgrid-mcp-server -
安装开发依赖:
bash
pip install -r requirements-dev.txt -
开发命令
所有开发命令都通过 nox 管理。查看noxfile.py
获取可用命令:
```bash
运行测试
nox -s tests
运行代码检查
nox -s lint
运行类型检查
nox -s type_check
更多...
```
⚙️ 配置
环境变量
创建一个 .env
文件,包含以下变量:
bash
SHOTGRID_URL=your_shotgrid_url
SHOTGRID_SCRIPT_NAME=your_script_name
SHOTGRID_SCRIPT_KEY=your_script_key
🔌 MCP 客户端配置
要在您的 MCP 客户端中使用 ShotGrid MCP 服务器,请将以下配置添加到客户端的设置中:
json
{
"mcpServers": {
"shotgrid-server": {
"command": "uvx",
"args": [
"shotgrid-mcp-server"
],
"env": {
"SHOTGRID_SCRIPT_NAME": "XXX",
"SHOTGRID_SCRIPT_KEY": "XX",
"SHOTGRID_URL": "XXXX"
},
"disabled": false,
"alwaysAllow": [
"search_entities",
"create_entity",
"batch_create",
"find_entity",
"get_entity_types",
"update_entity",
"download_thumbnail",
"batch_update",
"delete_entity",
"batch_delete"
]
}
}
}
🔑 凭证设置
替换以下值为您的 ShotGrid 凭证:
- SHOTGRID_SCRIPT_NAME
: 您的 ShotGrid 脚本名称
- SHOTGRID_SCRIPT_KEY
: 您的 ShotGrid 脚本密钥
- SHOTGRID_URL
: 您的 ShotGrid 服务器 URL
🛡️ 工具权限
alwaysAllow
部分列出了无需用户确认即可执行的工具。这些工具经过精心选择,以确保操作的安全性。