RenderDocMCP

# RenderDoc MCP Server MCP server that works as a RenderDoc UI extension. The AI assistant accesses RenderDoc capture data to assist with graphics debugging. ## Architecture ``` Claude/AI Client (stdio) │ ▼ MCP Server Process (Python + FastMCP 2.0) │ File-based IPC (%TEMP%/renderdoc_mcp/) ▼ RenderDoc Process (Extension) ``` Since RenderDoc's built-in Python does not have the `socket` module, communication is done via file-based IPC. ## Setup ### 1. Install RenderDoc Extension ```bash python scripts/install_extension.py ``` The extension is installed in `%APPDATA%\qrenderdoc\extensions\renderdoc_mcp_bridge`. ### 2. Enable the Extension in RenderDoc 1. Launch RenderDoc 2. Tools > Manage Extensions 3. Enable "RenderDoc MCP Bridge" ### 3. Install MCP Server ```bash uv tool install uv tool update-shell # Add to PATH ``` Restart the shell to use the `renderdoc-mcp` command. > **Note**: Adding `--editable` will immediately reflect changes to the source code (useful for development). > Use `uv tool install .` to install as a stable version. ### 4. Configure MCP Client #### Claude Desktop Add to `claude_desktop_config.json`: ```json { "mcpServers": { "renderdoc": { "command": "renderdoc-mcp" } } } ``` #### Claude Code Add to `.mcp.json`: ```json { "mcpServers": { "renderdoc": { "command": "renderdoc-mcp" } } } ``` ## Usage 1. Launch RenderDoc and open a capture file (.rdc) 2. Access RenderDoc data from the MCP client (Claude, etc.) ## MCP Tool List | Tool | Description | |--------|------| | `get_capture_status` | Check the capture loading status | | `get_draw_calls` | Get a list of draw calls in a hierarchical structure | | `get_draw_call_details` | Get detailed information for a specific draw call | | `get_shader_info` | Get the shader's source code and constant buffer values | | `get_buffer_contents` | Get the contents of the buffer (Base64) | | `get_texture_info` | Get texture metadata | | `get_texture_data` | Get texture pixel data (Base64) | | `get_pipeline_state` | Get pipeline state | ## Examples ### Get Draw Call List ``` get_draw_calls(include_children=true) ``` ### Get Shader Information ``` get_shader_info(event_id=123, stage="pixel") ``` ### Get Pipeline State ``` get_pipeline_state(event_id=123) ``` ### Get Texture Data ``` # Get mip 0 of a 2D texture get_texture_data(resource_id="ResourceId::123") # Get a specific mip level get_texture_data(resource_id="ResourceId::123", mip=2) # Get a specific face of a cube map (0=X+, 1=X-, 2=Y+, 3=Y-, 4=Z+, 5=Z-) get_texture_data(resource_id="ResourceId::456", slice=3) # Get a specific depth slice of a 3D texture get_texture_data(resource_id="ResourceId::789", depth_slice=5) ``` ### Get Partial Buffer Data ``` # Get the entire buffer get_buffer_contents(resource_id="ResourceId::123") # Get 512 bytes from offset 256 get_buffer_contents(resource_id="ResourceId::123", offset=256, length=512) ``` ## Requirements - Python 3.10+ - [uv](https://docs.astral.sh/uv/) - RenderDoc 1.20+ > **Note**: Operation has only been confirmed on Windows + DirectX 11 environments. > It may work on Linux/macOS + Vulkan/OpenGL environments, but has not been verified. ## License MIT