Skip to main content

dcc-mcp-renderdoc

DCC-MCP · RENDERDOC

Agent workflow

AI agents should use the shared gateway through dcc-mcp-cli; IDE users may continue to use the MCP endpoint. Prefer typed skills and tools over raw scripts.

Install or update the CLI

dcc-mcp-cli is the preferred control path for every shell-capable agent. If it is missing, ask the user before installing the latest official release:

# Linux/macOS
curl -fsSL https://raw.githubusercontent.com/dcc-mcp/dcc-mcp-core/main/scripts/install-cli.sh | sh

# Windows PowerShell
powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/dcc-mcp/dcc-mcp-core/main/scripts/install-cli.ps1 | iex"

Keep an official build current through the release manifest:

dcc-mcp-cli update check
dcc-mcp-cli update apply

update apply downloads and stages the latest CLI for the next launch. It does not update a running dcc-mcp-server; update that server in its own environment.

dcc-mcp-cli dcc-types
dcc-mcp-cli list
dcc-mcp-cli search --query "<task>" --dcc-type renderdoc
dcc-mcp-cli describe <tool-slug>
dcc-mcp-cli call <tool-slug> --json '{"key":"value"}'

dcc-types reports release-catalog support; list reports live sessions. If a tool belongs to an inactive progressive skill, call dcc-mcp-cli load-skill <skill-name> --dcc-type renderdoc before retrying. For post-task improvement, attach a stable session id with --meta-json, query dcc-mcp-cli stats --range 24h --session-id <task-id>, then pass the bounded evidence to the review_skill_improvement prompt from dcc-mcp-skills-creator.

RenderDoc capture and replay automation for the DCC Model Context Protocol ecosystem.

The adapter is headless-first: it reuses the official renderdoccmd executable for capture and conversion. Delayed capture uses RenderDoc's official Target Control API through the sibling qrenderdoc bundled Python runtime, without foreground focus or synthetic keyboard input.

Install

pip install dcc-mcp-renderdoc

See the complete Install SOP for supported versions, JSON doctor/verify, upgrades, cache integrity, uninstall, and troubleshooting.

Install RenderDoc separately, then expose its command line tool with either PATH or:

export DCC_MCP_RENDERDOC_CMD=/opt/renderdoc/bin/renderdoccmd
dcc-mcp-renderdoc

On Windows, set the variable to renderdoccmd.exe.

Plan and execute the standard lifecycle before starting the adapter:

dcc-mcp-renderdoc install --json
dcc-mcp-renderdoc install --json --yes
dcc-mcp-renderdoc status --json
dcc-mcp-renderdoc doctor --json
dcc-mcp-renderdoc verify --json

doctor is a compatibility preflight. install, status, verify, uninstall, and upgrade use the receipt-backed Install SOP v1 contract; mutating verbs plan unless --yes is supplied.

Each adapter instance uses an OS-assigned MCP port and registers it for CLI discovery. Connect through the stable gateway at http://127.0.0.1:9765/mcp; set DCC_MCP_RENDERDOC_PORT only when a fixed direct endpoint is required.

Agent workflows

  • Launch a game or test executable under RenderDoc and wait for a typed .rdc capture.
  • Trigger a capture through official Target Control after a configurable delay.
  • Inject into a process that had to be launched by a platform client, then trigger and collect a capture.
  • Reject no-work captures with actionable diagnostics while preserving the .rdc artifact.
  • Inspect capture driver, machine identity, chunk version, frame-work and Present counts, and representative calls.
  • Export a capture thumbnail for visual review.
  • Export Chrome trace JSON for timeline tooling.

The capture tool launches only the explicit executable and arguments supplied by the caller. It never invokes a shell. Analysis tools are read-only with respect to the .rdc input.

Pass trigger_after_secs to capture_program for a Target Control trigger. This requires qrenderdoc beside renderdoccmd. The official RenderDoc runtime supports Windows and Linux; macOS is covered only by this project's Python unit tests. Linux Target Control requires an X or Wayland display, so headless hosts must run under Xvfb (or explicitly configure a working Qt platform). The official Linux archive does not bundle Qt's offscreen platform plugin. Each sidecar uses an isolated Qt data profile with RenderDoc analytics explicitly opted out, preventing the first-run consent dialog without reading or changing the user's qrenderdoc configuration.

When a launcher creates the rendered child process, set hook_children=true and pass trigger_process_name. The adapter first checks the launched target itself; if its name does not match, it follows only that target's official NewChild messages to find a unique named child. A child name without child hooking fails before launch. Use capture_process only when the target is already running; late injection may not capture graphics devices created before RenderDoc was attached.

Real CI

CI downloads only the repository-pinned Linux RenderDoc archive and verifies its SHA-256 before extraction. It compiles a small OpenGL program, requests a real frame through Target Control under Xvfb using Qt's bundled xcb platform, asserts the structured trigger mode, calls the MCP analysis tool against the resulting .rdc, and verifies thumbnail and timeline exports. CI also validates all standard lifecycle receipts against the Install SOP v1 JSON schema, proves stable failure exits without downloading, and exercises install/status/verify/uninstall around the real pinned runtime.

Development

uv sync --extra dev
uv run python -m pytest
uv run ruff check src tests tools
uv run python tools/lint_skills.py

RenderDoc is an MIT-licensed graphics debugger maintained independently at renderdoc.org. This adapter is not affiliated with the RenderDoc project.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dcc_mcp_renderdoc-0.5.1.tar.gz (72.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dcc_mcp_renderdoc-0.5.1-py3-none-any.whl (54.2 kB view details)

Uploaded Python 3

File details

Details for the file dcc_mcp_renderdoc-0.5.1.tar.gz.

File metadata

  • Download URL: dcc_mcp_renderdoc-0.5.1.tar.gz
  • Upload date:
  • Size: 72.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dcc_mcp_renderdoc-0.5.1.tar.gz
Algorithm Hash digest
SHA256 a460b5ed3be8776ed123a7c6a6906a110ad77f83293cd12a9f134aee43939d75
MD5 ed4b5089e6e9cd98ad36d6963e004b81
BLAKE2b-256 23fdb17c3279f5cf697f987e6150cd4cfb5a9d838b95b381d2c8310a9ad85db4

See more details on using hashes here.

Provenance

The following attestation bundles were made for dcc_mcp_renderdoc-0.5.1.tar.gz:

Publisher: release.yml on dcc-mcp/dcc-mcp-renderdoc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dcc_mcp_renderdoc-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for dcc_mcp_renderdoc-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 46d47583b5e7c89a9537f6f8197996fcb6ddd8cbdf38932fedc77149005ac636
MD5 b4f19f0fcfab0828612924338b6b74b6
BLAKE2b-256 e9cde3566f3c347a46978e00a5c58d82907c3d6ac17ec2102e07f903136d3e95

See more details on using hashes here.

Provenance

The following attestation bundles were made for dcc_mcp_renderdoc-0.5.1-py3-none-any.whl:

Publisher: release.yml on dcc-mcp/dcc-mcp-renderdoc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.5.1 This release

2 files

0.5.0

2 files

0.4.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page