Skip to content

README.md

Latest commit

 

History

History
86 lines (64 loc) · 2.77 KB

README.md

File metadata and controls

86 lines (64 loc) · 2.77 KB

renderdoc-mcp
AI-native GPU frame debugging for RenderDoc

Release License: MIT
English | 简体中文

renderdoc-mcp is an MCP server and CLI that wraps the RenderDoc replay API into 59 structured tools, letting AI assistants (Claude, Codex, etc.) open .rdc captures, inspect GPU frames, debug shaders/pixels, compare captures, and export evidence — all without manual UI.

Demo

Demo

Features

Area What you can do
Session & Capture Open captures, live-capture frames, inspect metadata
Frame Navigation List events/draws, jump to any event
Pipeline & Shaders Inspect pipeline state, bindings, shader source, constant buffers
Resources & Passes Analyze frame structure, pass dependencies, resource usage
Pixel & Shader Debug Pixel history, pick pixel, debug pixel/vertex/thread
Export Render targets, textures, buffers, meshes, snapshots
Diff & Assertions Compare captures, assert pixels/state/images for CI

Download

Get the latest package from GitHub Releases. The zip contains:

File Description
bin/renderdoc-mcp.exe MCP server (stdio)
bin/renderdoc-cli.exe CLI for shell & CI
bin/renderdoc.dll / renderdoc.json Bundled RenderDoc runtime
skills/renderdoc-mcp/ Codex workflow skill
install-codex.ps1 One-click Codex Desktop installer

Client Configuration

Codex Desktop

The installer auto-configures ~/.codex/config.toml. Or add manually:

[mcp_servers.renderdoc-mcp]
command = 'renderdoc-mcp.exe'
args = []

Claude Code

{
  "mcpServers": {
    "renderdoc-mcp": {
      "command": "renderdoc-mcp.exe",
      "args": []
    }
  }
}

Build From Source

cmake -B build -DRENDERDOC_DIR=<path-to-renderdoc-source>
cmake --build build --config Release
Variable Required Description
RENDERDOC_DIR Yes RenderDoc source root
RENDERDOC_BUILD_DIR No RenderDoc build output (if non-standard location)

Architecture

Architecture

License

MIT. RenderDoc itself is under its own license.