MCP Server Shotgrid

🚀 自動化 Shotgun REST API 的 MCP 服務器

本項目藉助 FastMCP 實現了一個 MCP（模型上下文協議）服務器，旨在讓大型語言模型 (LLM) 代理能夠通過 Autodesk Shotgun 的 REST API 進行程序化交互。服務器提供了一系列工具，可用於查詢和管理 Shotgun 中的項目、資產和任務等實體。同時，該服務器支持 HTTP 和 transport="stdio" 模式，方便與基於 LLM 的工作流集成。

🚀 快速開始

本項目提供了一個使用 FastMCP 實現的 MCP 服務器，可讓大型語言模型 (LLM) 代理通過 Autodesk Shotgun 的 REST API 進行程序化交互。以下是快速開始的步驟：

✨ 主要特性

• 運用 OAuth2 認證連接至 Autodesk Shotgun。
• 通過 FastMCP 將 Shotgun REST API 操作作為 MCP 工具公開。
• 可查詢項目、資產和任務。
• 能獲取實體的詳細信息。
• 專為與基於 LLM 的工作流集成而設計。
• 代碼庫模塊化：main.py 負責 MCP 服務器和工具定義，shotgrid_rest.py 實現 Shotgun REST API 包裝器。
• 包含 test_main.py 用於自動化測試。

📦 安裝指南

需求

• Python 3.11
• httpx
• httpx-auth
• mcp.server.fastmcp

💻 使用示例

基礎用法

1. 設置 Shotgun 憑據

獲取您的 Shotgun 主機 URL、客戶端 ID 和客戶端秘密。

2. 運行服務器

用實際值替換佔位符後運行以下命令：

uv run --directory {REPO_DIR} main.py -host https://your-shotgrid-url -ci your_client_id -cs your_client_secret

所有三個參數都是必需的。支持短格式 (-host, -ci, -cs) 和長格式 (--host, --client-id, --client-secret)。服務器使用 FastMCP 並僅通過 transport="stdio" 模式通信。

3. 與您的 LLM 代理集成

服務器通過 MCP 為 LLM 提供可調用的工具。

高級用法

以下是服務器提供的可用工具，所有工具都是異步的，並通過 FastMCP 公開。括號中的參數是必需的。

• get_all_projects()
• get_all_users()
• get_all_projects_name_contains(name: str)
• get_all_projects_code_contains(code: str)
• get_all_sequences_in_project(project_name: str)
• get_all_shots_in_project(project_name: str)
• get_all_shots_code_contains(shot_code: str)
• get_all_assets_in_project(project_name: str)
• get_all_assets_code_contains(code: str)
• get_all_tasks_in_project(project_id: int)
• get_all_tasks_assigned_to_user(user_id: int)
• get_all_tasks_assigned_to_user_in_project_name(user_id: int, project_name: str)
• get_all_tasks_with_shot(shot_id: int)
• get_all_tasks_with_asset(asset_id: int)
• get_project_by_name(name: str)
• get_project_by_code(code: str)（新增）
• get_all_projects()
• get_project_details(project_id: int)
• get_project_assets(project_id: int, asset_type: str)（例如：Characters, Props, Sets）
• get_asset_versions(asset_id: int)
• get_version_thumbnail(version_id: int)（返回縮略圖的 URL）

📚 詳細文檔

注意事項

⚠️ 重要提示

• 確保安裝了所有依賴項。
• 在運行服務器之前，設置正確的 Shotgun 憑據。
• 測試工具時，請使用示例項目和資產以避免影響實際數據。

📄 許可證

本項目採用 MIT 許可證。