ShotGrid MCP Server Configuration Examples
This page provides various examples of how to configure ShotGrid MCP Server for different environments and use cases. These configuration examples demonstrate how to integrate the server into your pipeline.MCP Client Configuration
ShotGrid MCP Server follows the standard MCP configuration format. Since it’s a Python-based service, it usesuvx
as the command to launch the server. Below are configuration examples for various AI tools and IDEs.
Claude Desktop / Anthropic Claude
Cursor
Windsurf (Codeium)
Cline (VS Code Extension)
Visual Studio Code
VS Code User Settings
Environment Variables Configuration
For production deployments, you can use environment variables to configure the server:Python Configuration
When using the server in a Python script, you can configure it programmatically:Docker Compose Configuration
For containerized deployments, you can use Docker Compose:Configuration with Multiple Servers
You can configure multiple ShotGrid MCP Servers for different purposes, such as production and testing environments:Configuration with Custom Tools
You can configure the server to load custom tools from a specific module. This is useful when you want to extend the server with your own tools:your_custom_module.py
might look like:
Configuration with Authentication
For secure deployments, you can configure authentication for the MCP server:Integration with FastMCP
ShotGrid MCP Server is built on FastMCP, so you can use FastMCP features:MCP Configuration Reference
Here’s a reference of the supported configuration options for the ShotGrid MCP Server in the MCP configuration file:Field | Description |
---|---|
command | Must be "uvx" for Python-based ShotGrid MCP Server |
args | Array containing ["shotgrid-mcp-server"] or custom module path |
env.SHOTGRID_URL | URL of your ShotGrid instance |
env.SHOTGRID_SCRIPT_NAME | Script name for API authentication |
env.SHOTGRID_SCRIPT_KEY | API key for authentication |
env.SHOTGRID_CUSTOM_ENTITY_TYPES | Optional comma-separated list of custom entity types |
env.SHOTGUN_HTTP_PROXY | Optional HTTP proxy for ShotGrid API calls |
env.SHOTGUN_API_CACERTS | Optional path to CA certificates file |
Server Configuration Reference
Here’s a reference of the supported configuration options when initializing the ShotGrid MCP Server in Python:Parameter | Environment Variable | Type | Default | Description |
---|---|---|---|---|
name | - | str | ”shotgrid-server” | Name of the server |
shotgrid_url | SHOTGRID_URL | str | None | URL of your ShotGrid instance |
script_name | SHOTGRID_SCRIPT_NAME | str | None | Script name for API authentication |
script_key | SHOTGRID_SCRIPT_KEY | str | None | API key for authentication |
http_proxy | SHOTGUN_HTTP_PROXY | str | None | HTTP proxy for ShotGrid API calls |
ca_certs | SHOTGUN_API_CACERTS | str | None | Path to CA certificates file |
Next Steps
Now that you’ve seen examples of how to configure ShotGrid MCP Server, you can:- Check out the Usage Examples for practical examples of using the server
- Learn about optimized queries for better performance
- Explore batch operations for efficient data manipulation