cudaq-docs-mcp: Instructions file for Claude Code

CLAUDE.md

cudaq-docs-mcp CLAUDE.md is an instructions file for Claude Code from rogerawong/cudaq-docs-mcp. It costs 507 tokens per session, scanned A, original, Apache-2.0.

Instructions for a local MCP server that gives AI agents access to NVIDIA CUDA-Q documentation, API reference material, and runnable examples. CUDA-Q is NVIDIA's software for writing and running quantum-classical programs.

In plain words
What is it for?
Use it to search CUDA-Q documentation, API symbols, and example programs while developing or testing CUDA-Q code.
Why use it?
It keeps the documentation tied to the installed CUDA-Q version, reducing confusion from using mismatched API information.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md.

This is rogerawong/cudaq-docs-mcp's own configuration. It tells Claude Code how to work on cudaq-docs-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything cudaq-docs-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to rogerawong/cudaq-docs-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/rogerawong/cudaq-docs-mcp/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/rogerawong/cudaq-docs-mcp

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for cudaq-docs-mcp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/rogerawong/cudaq-docs-mcp/claude-md/github.svg)](https://agentmods.dev/instructions/rogerawong/cudaq-docs-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/rogerawong/cudaq-docs-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/rogerawong/cudaq-docs-mcp/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for cudaq-docs-mcp CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/rogerawong/cudaq-docs-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/rogerawong/cudaq-docs-mcp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 507 This file is loaded in full into every session.
When invoked 507 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00507 $0.00507
Opus 5 $0.00253 $0.00253
Sonnet 5 $0.00101 $0.00101
Haiku 4.5 $0.00051 $0.00051

Measured 8d ago against content hash cbdde2e84742, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

cudaq-docs-mcp CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 28 lines

How it starts

The opening of the file, as written. The whole thing — 28 lines — stays where its author put it; the contents beside it link to each section on GitHub.

cudaq-docs-mcp

MCP server serving NVIDIA CUDA-Q docs to agents, version-pinned to the installed cudaq package.

Commands

.venv/bin/pytest                                  # unit tests, offline
.venv/bin/cudaq-docs-mcp build --limit 25         # smoke index build (network)
.venv/bin/cudaq-docs-mcp build --version latest   # full index build
.venv/bin/cudaq-docs-mcp info                     # cache dir, indexed versions
.venv/bin/python scripts/smoke_mcp.py             # end-to-end MCP stdio session

Commands assume the repo venv at .venv. Where the package is installed into a different environment (a codespace, for example), drop the prefix and call cudaq-docs-mcp, pytest, and python from that environment directly.

Architecture

Pipeline: inventory.py parses CUDA-Q's Sphinx objects.inv (crawl manifest + API symbols) → ingest.py fetches the site's .md mirrors and repo example files → clean.py strips RTD theme chrome from the pandoc-converted mirrors, rebuilds fenced code blocks, extracts heading anchors, chunks by heading → db.py stores pages/chunks/api/examples in one SQLite file per docs version with FTS5 (porter, bm25). server.py exposes five tools + two resources on MCP SDK v2's MCPServer; detect.py resolves the default docs version from installed cudaq distribution metadata; targets.py + data/targets.json is the hand-curated backend matrix; assets.py downloads prebuilt indexes from GitHub release assets; cli.py wires serve/build/info.

Constraints

  • Runtime deps are exactly mcp and httpx; everything else is stdlib. Do not add deps casually.
  • Tests must stay offline; network behavior is exercised through the manual commands above.
  • Version resolution order (explicit arg → installed cudaq → latest) is the product thesis; do not change it silently.
  • data/targets.json is curated from the docs by hand; when editing, verify names against the backends pages and update docs_reviewed.
  • Repo prose (README, CONTRIBUTING) follows the maintainer's style: no em dashes, "via" is banned, Oxford comma, AP-style numbers.

Read the full file on GitHub · 28 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 8d ago First seen · 28 lines · 507 tokens per session scan A cbdde2e84742

Subscribe to this mod's changes

cudaq-docs-mcp CLAUDE.md is an instructions file published in the GitHub repository rogerawong/cudaq-docs-mcp (1 stars, last pushed 14d ago), licensed Apache-2.0. It adds 507 tokens to every session, about $0.0025 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens