Qiskit Documentation MCP Server — Claude Code MCP server
MCP server that gives your agent direct access to Qiskit SDK documentation, implementation guides, and API reference. No tokens required, updates automatically.
claude mcp add --env QISKIT_DOCS_BASE=<QISKIT_DOCS_BASE> --env QISKIT_HTTP_TIMEOUT=<QISKIT_HTTP_TIMEOUT> --transport stdio qiskit-docs-mcp-server -- uvx qiskit-docs-mcp-serverWhat Qiskit Documentation MCP Server does
The server exposes three tools: documentation search with scope filters, full page retrieval by URL or path, and error code lookup. Lists of modules, addons, guides, and API packages are pulled from the live sitemap and cached.
Requires Python 3.10+ and the uv package manager. Page and search cache duration is controlled via QISKIT_DOCS_CACHE_TTL and QISKIT_SEARCH_CACHE_TTL environment variables.
Returns documentation in Markdown. Content is fetched over HTTP from quantum.cloud.ibm.com, with a 10-second default timeout.
What it helps with
- retrieve Qiskit module API reference in-context
- find guides on circuit optimization or error mitigation
- decode an IBM Quantum error code
- check syntax for a Qiskit SDK method or class
- load the full list of tutorials and guides
Example prompts for the agent
- Find documentation on dynamic circuits in Qiskit
- Show API reference for
qiskit.circuitmodule - What does error code 7001 mean in Qiskit?
How to install Qiskit Documentation MCP Server
Platform CLI
claude mcp add --env QISKIT_DOCS_BASE=<QISKIT_DOCS_BASE> --env QISKIT_HTTP_TIMEOUT=<QISKIT_HTTP_TIMEOUT> --transport stdio qiskit-docs-mcp-server -- uvx qiskit-docs-mcp-serverReplace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from qiskit-docs-mcp-server <command>
Platform CLI
codex mcp add qiskit-docs-mcp-server --env QISKIT_DOCS_BASE=<QISKIT_DOCS_BASE> --env QISKIT_HTTP_TIMEOUT=<QISKIT_HTTP_TIMEOUT> -- uvx qiskit-docs-mcp-serverReplace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from qiskit-docs-mcp-server <command>
Config file
{
"mcpServers": {
"qiskit-docs-mcp-server": {
"command": "uvx",
"args": [
"qiskit-docs-mcp-server"
],
"env": {
"QISKIT_DOCS_BASE": "<QISKIT_DOCS_BASE>",
"QISKIT_HTTP_TIMEOUT": "<QISKIT_HTTP_TIMEOUT>"
}
}
}
}Replace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from qiskit-docs-mcp-server <command>
Config file
{
"servers": {
"qiskit-docs-mcp-server": {
"type": "stdio",
"command": "uvx",
"args": [
"qiskit-docs-mcp-server"
],
"env": {
"QISKIT_DOCS_BASE": "<QISKIT_DOCS_BASE>",
"QISKIT_HTTP_TIMEOUT": "<QISKIT_HTTP_TIMEOUT>"
}
}
}
}Replace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from qiskit-docs-mcp-server <command>
Platform CLI
gemini mcp add -e QISKIT_DOCS_BASE=<QISKIT_DOCS_BASE> -e QISKIT_HTTP_TIMEOUT=<QISKIT_HTTP_TIMEOUT> qiskit-docs-mcp-server uvx qiskit-docs-mcp-serverReplace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from qiskit-docs-mcp-server <command>
Step by step, with commands for each platform: How to add an MCP server to Claude Code, Codex, Cursor, VS Code, Gemini CLI and more
Questions about Qiskit Documentation MCP Server
How to install Qiskit Documentation MCP Server in Claude Code?
Run claude mcp add qiskit-docs-mcp-server -- uvx qiskit-docs-mcp-server. The server will install via uvx and become available to the agent.
What does Qiskit Documentation MCP Server do?
The server gives your agent access to Qiskit documentation: SDK modules, guides, tutorials, and API reference. Supports search, page retrieval, and error code lookup.
Does the server require API keys?
No. It reads public IBM Quantum documentation without authentication. An internet connection is all you need.
