MCP Server Shotgrid

🚀 Automated MCP Server for Shotgun REST API

This project offers an MCP (Model Context Protocol) server implemented with FastMCP, enabling large language model (LLM) agents to interact programmatically with Autodesk Shotgun's REST API. The server exposes a set of tools for querying and managing Shotgun entities such as projects, assets, and tasks. It supports both HTTP and transport="stdio" modes, facilitating integration with LLM-based workflows.

✨ Features

• Connect to Autodesk Shotgun using OAuth2 authentication.
• Expose Shotgun REST API operations as MCP tools via FastMCP.
• Query projects, assets, and tasks.
• Retrieve detailed information about entities.
• Designed for integration with LLM-based workflows.
• Modular codebase: main.py provides the MCP server and tool definitions, while shotgrid_rest.py implements the Shotgun REST API wrapper.
• Includes test_main.py for automated testing.

📦 Installation

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

💻 Usage Examples

Basic Usage

1. Set up Shotgun credentials:

   • Obtain your Shotgun host URL, client ID, and client secret.

2. Run the server (replace placeholders with actual values):

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

   All three parameters are required. Both short formats (-host, -ci, -cs) and long formats (--host, --client-id, --client-secret) are supported. The server uses FastMCP and communicates only via the transport="stdio" mode.

3. Integrate with your LLM agent:

   • The server provides callable tools for the LLM via MCP.

Advanced Usage

All tools are asynchronous and exposed via FastMCP.

Available tools:
Parameters in parentheses are required.

• 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) (New)
• get_all_projects()
• get_project_details(project_id: int)
• get_project_assets(project_id: int, asset_type: str) (e.g., Characters, Props, Sets)
• get_asset_versions(asset_id: int)
• get_version_thumbnail(version_id: int) (Returns the URL of the thumbnail)

⚠️ Important Note

• Ensure all dependencies are installed.
• Set the correct Shotgun credentials before running the server.
• When testing the tools, use sample projects and assets to avoid affecting real data.

📄 License

This project is under the MIT License.