Render Doc MCP

声明

本仓库基于 https://github.com/halby24/RenderDocMCP 进行功能扩展，扩展了以下功能：

1. 现在支持所有图形API的buffer content获取
2. remote-device-replay

下文是原仓库README的中文版翻译：

RenderDoc MCP 服务器

作为 RenderDoc UI 扩展运行的 MCP 服务器。使 AI 助手能够访问 RenderDoc 的捕获数据，辅助图形调试。

架构

Claude/AI 客户端 (stdio)
        │
        ▼
MCP 服务器进程 (Python + FastMCP 2.0)
        │ 基于文件的 IPC (%TEMP%/renderdoc_mcp/)
        ▼
RenderDoc 进程 (扩展)

由于 RenderDoc 内置的 Python 没有 socket 模块，因此通过基于文件的 IPC 进行通信。

安装配置

1. 安装 RenderDoc 扩展

python scripts/install_extension.py

扩展将安装到 %APPDATA%\qrenderdoc\extensions\renderdoc_mcp_bridge。

2. 在 RenderDoc 中启用扩展

1. 启动 RenderDoc
2. 打开 Tools > Manage Extensions
3. 启用 "RenderDoc MCP Bridge"

3. 安装 MCP 服务器

uv tool install
uv tool update-shell  # 添加到 PATH

重启终端后即可使用 renderdoc-mcp 命令。

注意：添加 --editable 参数后，源代码的修改会立即生效（开发时很方便）。 如果作为稳定版安装，请使用 uv tool install .。

4. 配置 MCP 客户端

Claude Desktop

在 claude_desktop_config.json 中添加：

{
  "mcpServers": {
    "renderdoc": {
      "command": "renderdoc-mcp"
    }
  }
}

Claude Code

在 .mcp.json 中添加：

{
  "mcpServers": {
    "renderdoc": {
      "command": "renderdoc-mcp"
    }
  }
}

使用方法

1. 启动 RenderDoc，打开捕获文件 (.rdc)
2. 通过 MCP 客户端（如 Claude）访问 RenderDoc 的数据

MCP 工具列表

使用示例

获取绘制调用列表

get_draw_calls(include_children=true)

获取着色器信息

get_shader_info(event_id=123, stage="pixel")

获取管线状态

get_pipeline_state(event_id=123)

获取纹理数据

# 获取 2D 纹理的 mip 0
get_texture_data(resource_id="ResourceId::123")

# 获取特定的 mip 级别
get_texture_data(resource_id="ResourceId::123", mip=2)

# 获取立方体贴图的特定面 (0=X+, 1=X-, 2=Y+, 3=Y-, 4=Z+, 5=Z-)
get_texture_data(resource_id="ResourceId::456", slice=3)

# 获取 3D 纹理的特定深度切片
get_texture_data(resource_id="ResourceId::789", depth_slice=5)

部分获取缓冲区数据

# 获取整个缓冲区
get_buffer_contents(resource_id="ResourceId::123")

# 从偏移量 256 开始获取 512 字节
get_buffer_contents(resource_id="ResourceId::123", offset=256, length=512)

系统要求

• Python 3.10+
• uv
• RenderDoc 1.20+

注意：仅在 Windows + DirectX 11 环境下进行过测试验证。 在 Linux/macOS + Vulkan/OpenGL 环境下可能也能运行，但尚未验证。

许可证

MIT