项目简介

ShotGrid MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器,专为与 ShotGrid 项目管理软件集成而设计。它充当 LLM 客户端和 ShotGrid 之间的桥梁,使得 LLM 应用能够以标准化的方式访问和操作 ShotGrid 中的资产、镜头、任务等数据。

主要功能点

  • 资源管理: 提供对 ShotGrid 实体(如资产、镜头、任务等)的创建、读取、更新和删除 (CRUD) 操作。
  • 工具集: 内置丰富的工具,包括实体数据查询、缩略图下载/上传等,方便 LLM 应用调用。
  • 高性能: 基于 'fastmcp' 框架构建,保证服务器的高效运行和快速响应。
  • 易于部署: 使用 'uv pip install' 即可快速安装,并支持多种配置方式。
  • 完善的测试: 拥有全面的单元测试覆盖,确保服务器的稳定性和可靠性。

安装步骤

  1. 确保已安装 UV 包管理器。
  2. 使用 UV 安装 ShotGrid MCP Server:
    uv pip install shotgrid-mcp-server

服务器配置

为了让 MCP 客户端连接到 ShotGrid MCP Server,需要在客户端的配置中添加服务器信息。以下是一个典型的 JSON 配置示例,请根据你的 ShotGrid 环境进行修改:

{
  "mcpServers": {
    "shotgrid-server": {
      "command": "uvx",
      "args": [
        "shotgrid-mcp-server"
      ],
      "env": {
        "SHOTGRID_SCRIPT_NAME": "YOUR_SHOTGRID_SCRIPT_NAME", // 替换为你的 ShotGrid Script Name
        "SHOTGRID_SCRIPT_KEY": "YOUR_SHOTGRID_SCRIPT_KEY",   // 替换为你的 ShotGrid Script Key
        "SHOTGRID_URL": "YOUR_SHOTGRID_URL"                  // 替换为你的 ShotGrid 服务器 URL
      },
      "disabled": false,
      "alwaysAllow": [ // 默认允许执行的工具列表,无需用户确认
        "search_entities",
        "create_entity",
        "batch_create",
        "find_entity",
        "get_entity_types",
        "update_entity",
        "download_thumbnail",
        "batch_update",
        "delete_entity",
        "batch_delete"
      ]
    }
  }
}

配置参数说明:

  • 'command': 启动服务器的命令,这里使用 'uvx' 运行已安装的 'shotgrid-mcp-server' 包。
  • 'args': 命令参数,这里为空列表。
  • 'env': 环境变量配置,用于 ShotGrid API 认证:
    • 'SHOTGRID_SCRIPT_NAME': 你的 ShotGrid 脚本名称。
    • 'SHOTGRID_SCRIPT_KEY': 你的 ShotGrid 脚本密钥。
    • 'SHOTGRID_URL': 你的 ShotGrid 服务器 URL 地址。
  • 'disabled': 设置为 'false' 启用服务器。
  • 'alwaysAllow': 列出无需用户确认即可执行的工具名称,用于配置安全策略。

请将 'YOUR_SHOTGRID_SCRIPT_NAME', 'YOUR_SHOTGRID_SCRIPT_KEY', 和 'YOUR_SHOTGRID_URL' 替换为你在 ShotGrid 中配置的脚本名称、密钥和服务器地址。

基本使用方法

  1. 启动服务器: 配置完成后,MCP 客户端即可尝试连接到 ShotGrid MCP Server。在开发环境中,可以使用以下命令启动服务器,并启用热重载:
    uv run fastmcp dev src\shotgrid_mcp_server\server.py:app
    在生产环境中,可以使用以下命令启动服务器:
    uvx shotgrid-mcp-server
  2. 客户端连接: 在 MCP 客户端中配置上述服务器信息,客户端即可通过 MCP 协议与 ShotGrid MCP Server 通信。
  3. 调用工具: 客户端可以调用服务器提供的各种工具,例如 'create_entity' 创建 ShotGrid 实体, 'search_entities' 查询实体数据, 'download_thumbnail' 下载缩略图等,具体工具列表请参考项目文档或源代码。

更多信息

更详细的 API 文档和高级配置指南,请查阅仓库的 '/docs' 目录。

信息

分类

商业系统