World Monitor
Real-time global intelligence on conflict, markets, energy, trade, shipping and cyber. 97 tools.
MCP server for querying and retrieving Qiskit documentation, guides, and API references
Listen sind nach einem Nutzungswert (von 100) aus diesen Teilen sortiert
| Beliebtheit | 15/80 | GitHub-Sterne oder wöchentliche Downloads: der größere Wert zählt 60, der kleinere 20 |
|---|---|---|
| Aktualität | 7/12 | Volle Punkte für Release oder Codeänderung in 30 Tagen |
| Antwortet noch | 0/8 | Der Cloud-Endpoint antwortete bei der letzten Prüfung |
| Nutzungswert | 22/100 |
Qualität: 3/3 Basisprüfungen bestanden (angezeigt, nicht zur Sortierung) · Schwung: Noch keine Daten (Nur im Tab Im Trend verwendet)
Wähle die KI-App, die du nutzt, und kopiere die Einstellungen.
3/3 Prüfungen bestanden · Läuft auf deinem Computer · ✓ Befehle geprüft am 14. Nov. 2026
Zuerst: Welche KI nutzt du?
Wähle deine App, dann erscheinen die Schritte unten.
Klappt mit Claude, aber erst etwas vorbereiten
Installiere zuerst Python (uv) auf deinem Computer (nur einmal) · Nur in der Claude-App für den Computer (Windows oder Mac), nicht im Web oder auf dem Handy
Kopiere diese Nachricht in einen Claude-Chat. Die KI prüft deinen Rechner, sagt dir, welche Datei sie ändert, und wartet jedes Mal auf dein OK.
Installiere bitte den MCP server Qiskit Documentation MCP Server für Claude auf diesem Rechner, in dieser Reihenfolge: 1) Prüfe uv mit uv --version. Fehlt es, sag mir, dass ich es von https://docs.astral.sh/uv/getting-started/installation/ installiere; installiere es nicht selbst. 2) Verwende nur diese Konfiguration (von PopNx MCP geprüft): { "mcpServers": { "qiskit-docs": { "command": "uvx", "args": [ "qiskit-docs-mcp-server" ] } } } 3) Nenne mir den vollständigen Pfad der Datei, die du änderst, oder den Befehl, den du ausführst, und warte auf mein OK. 4) Kein Schlüssel nötig. 5) Führe das Vereinbarte aus und prüfe, dass die Tools von Qiskit Documentation MCP Server wirklich erscheinen.Diese Nachricht enthält keinen Schlüssel. Wird einer gebraucht, bittet dich die KI, ihn selbst in die Datei oder das Feld der App einzufügen.
Schon installiert? Zuerst prüfen · Öffne das Terminal, gib diesen Befehl ein und drücke Enter
uv --versionMac: ⌘ + Leertaste drücken, Terminal eingeben, Enter
Windows: Start öffnen, Windows PowerShell eingeben, dann Öffnen
Noch nicht installiert: uv hat keinen Klick-Installer. Kopiere den Einzeiler für dein System (macOS oder Windows) von der offiziellen uv-Seite ins Terminal · Python muss nicht extra installiert werden, uv lädt es bei Bedarf selbst
Download-Seite von uv öffnen ↗
Danach das Terminal schließen, neu öffnen und denselben Befehl erneut ausführen. Es muss eine Versionsnummer erscheinen: uv --version
Einmal installieren, gilt für alles, was uv braucht
SettingsDeveloperEdit Config
{
"mcpServers": {
"qiskit-docs": {
"command": "uvx",
"args": [
"qiskit-docs-mcp-server"
]
}
}
}Nutze Qiskit Documentation MCP Server und sag mir, was du für mich tun kannst; zeig mir dann eine Sache✓ Wenn Claude sagt, dass es Qiskit Documentation MCP Server nutzt, oder ein Werkzeug von Qiskit Documentation MCP Server in der Antwort zeigt, bist du verbunden
Der Befehl oben funktioniert auch ohne diese Werte. Füge sie nur hinzu, wenn du etwas ändern willst, nach der Beschreibung des Autors.
QISKIT_DOCS_BASE Base URL for Qiskit documentation · Standard https://quantum.cloud.ibm.com/docs/QISKIT_HTTP_TIMEOUT HTTP-Anfrage-Timeout in Sekunden Beschreibungen automatisch übersetzt; Variablennamen bleiben wie im Original. Im Zweifel das Original ansehen.
Menünamen am 11. Nov. 2026 mit der Hilfe von Anthropic abgeglichen · dein Bildschirm kann je nach App-Version leicht abweichen
ChatGPT kann Qiskit Documentation MCP Server noch nicht verbinden
Qiskit Documentation MCP Server läuft auf deinem Computer, aber ChatGPT verbindet nur Server, die im Web laufen
A · Eine App nutzen, die Qiskit Documentation MCP Server verbinden kann
B · Andere in Sonstiges, die mit ChatGPT funktionieren
Aus den meistgenutzten derselben Kategorie, nur solche, die per Adresse ohne Schlüssel verbinden
Klappt mit Claude Code, aber erst etwas vorbereiten
Installiere zuerst Python (uv) auf deinem Computer (nur einmal)
Kopiere diese Nachricht in einen Claude Code-Chat. Die KI prüft deinen Rechner, sagt dir, welche Datei sie ändert, und wartet jedes Mal auf dein OK.
Installiere bitte den MCP server Qiskit Documentation MCP Server für Claude Code auf diesem Rechner, in dieser Reihenfolge: 1) Prüfe uv mit uv --version. Fehlt es, sag mir, dass ich es von https://docs.astral.sh/uv/getting-started/installation/ installiere; installiere es nicht selbst. 2) Verwende nur diese Konfiguration (von PopNx MCP geprüft): claude mcp add --scope user qiskit-docs -- uvx qiskit-docs-mcp-server 3) Nenne mir den vollständigen Pfad der Datei, die du änderst, oder den Befehl, den du ausführst, und warte auf mein OK. 4) Kein Schlüssel nötig. 5) Führe das Vereinbarte aus und prüfe, dass die Tools von Qiskit Documentation MCP Server wirklich erscheinen.Diese Nachricht enthält keinen Schlüssel. Wird einer gebraucht, bittet dich die KI, ihn selbst in die Datei oder das Feld der App einzufügen.
Schon installiert? Zuerst prüfen · Öffne das Terminal, gib diesen Befehl ein und drücke Enter
uv --versionMac: ⌘ + Leertaste drücken, Terminal eingeben, Enter
Windows: Start öffnen, Windows PowerShell eingeben, dann Öffnen
Noch nicht installiert: uv hat keinen Klick-Installer. Kopiere den Einzeiler für dein System (macOS oder Windows) von der offiziellen uv-Seite ins Terminal · Python muss nicht extra installiert werden, uv lädt es bei Bedarf selbst
Download-Seite von uv öffnen ↗
Danach das Terminal schließen, neu öffnen und denselben Befehl erneut ausführen. Es muss eine Versionsnummer erscheinen: uv --version
Einmal installieren, gilt für alles, was uv braucht
Mac: Command+Leertaste drücken und Terminal tippen · Windows: PowerShell öffnen
claude mcp add --scope user qiskit-docs -- uvx qiskit-docs-mcp-serverQiskit Documentation MCP Server sollte in der Liste als verbunden erscheinen
Nutze Qiskit Documentation MCP Server und sag mir, was du für mich tun kannst; zeig mir dann eine Sache✓ Wenn Claude Code sagt, dass es Qiskit Documentation MCP Server nutzt, oder ein Werkzeug von Qiskit Documentation MCP Server in der Antwort zeigt, bist du verbunden
Der Befehl oben funktioniert auch ohne diese Werte. Füge sie nur hinzu, wenn du etwas ändern willst, nach der Beschreibung des Autors.
QISKIT_DOCS_BASE Base URL for Qiskit documentation · Standard https://quantum.cloud.ibm.com/docs/QISKIT_HTTP_TIMEOUT HTTP-Anfrage-Timeout in Sekunden Beschreibungen automatisch übersetzt; Variablennamen bleiben wie im Original. Im Zweifel das Original ansehen.
Menünamen am 11. Nov. 2026 mit der Hilfe von Anthropic abgeglichen · dein Bildschirm kann je nach App-Version leicht abweichen
Klappt mit Cursor, aber erst etwas vorbereiten
Installiere zuerst Python (uv) auf deinem Computer (nur einmal)
Kopiere diese Nachricht in einen Cursor-Chat. Die KI prüft deinen Rechner, sagt dir, welche Datei sie ändert, und wartet jedes Mal auf dein OK.
Installiere bitte den MCP server Qiskit Documentation MCP Server für Cursor auf diesem Rechner, in dieser Reihenfolge: 1) Prüfe uv mit uv --version. Fehlt es, sag mir, dass ich es von https://docs.astral.sh/uv/getting-started/installation/ installiere; installiere es nicht selbst. 2) Verwende nur diese Konfiguration (von PopNx MCP geprüft): { "mcpServers": { "qiskit-docs": { "command": "uvx", "args": [ "qiskit-docs-mcp-server" ] } } } 3) Nenne mir den vollständigen Pfad der Datei, die du änderst, oder den Befehl, den du ausführst, und warte auf mein OK. 4) Kein Schlüssel nötig. 5) Führe das Vereinbarte aus und prüfe, dass die Tools von Qiskit Documentation MCP Server wirklich erscheinen.Diese Nachricht enthält keinen Schlüssel. Wird einer gebraucht, bittet dich die KI, ihn selbst in die Datei oder das Feld der App einzufügen.
Schon installiert? Zuerst prüfen · Öffne das Terminal, gib diesen Befehl ein und drücke Enter
uv --versionMac: ⌘ + Leertaste drücken, Terminal eingeben, Enter
Windows: Start öffnen, Windows PowerShell eingeben, dann Öffnen
Noch nicht installiert: uv hat keinen Klick-Installer. Kopiere den Einzeiler für dein System (macOS oder Windows) von der offiziellen uv-Seite ins Terminal · Python muss nicht extra installiert werden, uv lädt es bei Bedarf selbst
Download-Seite von uv öffnen ↗
Danach das Terminal schließen, neu öffnen und denselben Befehl erneut ausführen. Es muss eine Versionsnummer erscheinen: uv --version
Einmal installieren, gilt für alles, was uv braucht
Nutze Qiskit Documentation MCP Server und sag mir, was du für mich tun kannst; zeig mir dann eine Sache✓ Wenn Cursor sagt, dass es Qiskit Documentation MCP Server nutzt, oder ein Werkzeug von Qiskit Documentation MCP Server in der Antwort zeigt, bist du verbunden
Der Befehl oben funktioniert auch ohne diese Werte. Füge sie nur hinzu, wenn du etwas ändern willst, nach der Beschreibung des Autors.
QISKIT_DOCS_BASE Base URL for Qiskit documentation · Standard https://quantum.cloud.ibm.com/docs/QISKIT_HTTP_TIMEOUT HTTP-Anfrage-Timeout in Sekunden Beschreibungen automatisch übersetzt; Variablennamen bleiben wie im Original. Im Zweifel das Original ansehen.
Menünamen am 11. Nov. 2026 mit der Hilfe von Cursor abgeglichen · dein Bildschirm kann je nach App-Version leicht abweichen
Klappt mit VS Code, aber erst etwas vorbereiten
Installiere zuerst Python (uv) auf deinem Computer (nur einmal)
Kopiere diese Nachricht in einen VS Code-Chat. Die KI prüft deinen Rechner, sagt dir, welche Datei sie ändert, und wartet jedes Mal auf dein OK.
Installiere bitte den MCP server Qiskit Documentation MCP Server für VS Code auf diesem Rechner, in dieser Reihenfolge: 1) Prüfe uv mit uv --version. Fehlt es, sag mir, dass ich es von https://docs.astral.sh/uv/getting-started/installation/ installiere; installiere es nicht selbst. 2) Verwende nur diese Konfiguration (von PopNx MCP geprüft): { "servers": { "qiskit-docs": { "type": "stdio", "command": "uvx", "args": [ "qiskit-docs-mcp-server" ] } } } 3) Nenne mir den vollständigen Pfad der Datei, die du änderst, oder den Befehl, den du ausführst, und warte auf mein OK. 4) Kein Schlüssel nötig. 5) Führe das Vereinbarte aus und prüfe, dass die Tools von Qiskit Documentation MCP Server wirklich erscheinen.Diese Nachricht enthält keinen Schlüssel. Wird einer gebraucht, bittet dich die KI, ihn selbst in die Datei oder das Feld der App einzufügen.
Schon installiert? Zuerst prüfen · Öffne das Terminal, gib diesen Befehl ein und drücke Enter
uv --versionMac: ⌘ + Leertaste drücken, Terminal eingeben, Enter
Windows: Start öffnen, Windows PowerShell eingeben, dann Öffnen
Noch nicht installiert: uv hat keinen Klick-Installer. Kopiere den Einzeiler für dein System (macOS oder Windows) von der offiziellen uv-Seite ins Terminal · Python muss nicht extra installiert werden, uv lädt es bei Bedarf selbst
Download-Seite von uv öffnen ↗
Danach das Terminal schließen, neu öffnen und denselben Befehl erneut ausführen. Es muss eine Versionsnummer erscheinen: uv --version
Einmal installieren, gilt für alles, was uv braucht
VS Code fragt nach einer Bestätigung; klicke Install
Nutze Qiskit Documentation MCP Server und sag mir, was du für mich tun kannst; zeig mir dann eine Sache✓ Wenn VS Code sagt, dass es Qiskit Documentation MCP Server nutzt, oder ein Werkzeug von Qiskit Documentation MCP Server in der Antwort zeigt, bist du verbunden
Der Befehl oben funktioniert auch ohne diese Werte. Füge sie nur hinzu, wenn du etwas ändern willst, nach der Beschreibung des Autors.
QISKIT_DOCS_BASE Base URL for Qiskit documentation · Standard https://quantum.cloud.ibm.com/docs/QISKIT_HTTP_TIMEOUT HTTP-Anfrage-Timeout in Sekunden Beschreibungen automatisch übersetzt; Variablennamen bleiben wie im Original. Im Zweifel das Original ansehen.
Menünamen am 11. Nov. 2026 mit der Hilfe von VS Code abgeglichen · dein Bildschirm kann je nach App-Version leicht abweichen
Andere Apps mit MCP, etwa Windsurf, Zed oder Gemini CLI, fügen Server unterschiedlich hinzu. Sieh in der App-Liste nach
JSON-Einstellungen stehen unten unter „Für Entwickler“
Claude Code
claude mcp add --scope user qiskit-docs -- uvx qiskit-docs-mcp-serverClaude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"qiskit-docs": {
"command": "uvx",
"args": [
"qiskit-docs-mcp-server"
]
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"qiskit-docs": {
"command": "uvx",
"args": [
"qiskit-docs-mcp-server"
]
}
}
}VS Code (mcp.json)
{
"servers": {
"qiskit-docs": {
"type": "stdio",
"command": "uvx",
"args": [
"qiskit-docs-mcp-server"
]
}
}
}QISKIT_DOCS_BASE envQISKIT_HTTP_TIMEOUT envBeschreibungen automatisch übersetzt; Variablennamen bleiben wie im Original. Im Zweifel das Original ansehen.
Diese Einstellungen werden aus dem Registry-Eintrag des Entwicklers erzeugt. Wenn in der README etwas anderes steht, folge der README.
pypi: qiskit-docs-mcp-serverBasierend darauf, wie sich dieser Server verbindet, und auf der eigenen Doku jeder App, geprüft am 10. Nov. 2026.
Laufen auf deinem Computer in
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
Läuft auf deinem Computer; die Tool-Liste erscheint nach der Installation in deiner KI-App.
Wir prüfen Informationen, die jeder sehen kann; den Code haben wir nicht gelesen. Checks, die nicht zutreffen, werden nicht mitgezählt. · Geprüft am 16. Nov. 2026
Der Registry-Name wurde mit dem GitHub-Konto Qiskit bestätigt, dem das Repo gehört
Code zuletzt geändert: vor 39 Tagen
Nutzt Apache-2.0
Dieser Server läuft auf deinem Computer; es gibt keinen Endpunkt im Internet
Läuft auf deinem Computer und nutzt stattdessen lokale Einstellungen
Läuft auf deinem Computer; Tool-Listen können wir nur von Endpunkten im Internet lesen
Keine Einträge auf OSV.dev für qiskit-docs-mcp-server@0.3.0
Prüft nur diese Paketversion, nicht alle Abhängigkeiten · geprüft 15. Nov. 2026
Wenn du das gebaut hast, füge diesen Code in dein README ein. Das Badge verlinkt auf diese Seite.
[](https://mcp.popnx.com/en/servers/qiskit-docs-mcp-server)Fragen, Tipps teilen oder melden, dass etwas nicht geht. Sortiert nach „hilfreich“.
Noch keine Beiträge. Stell die erste Frage oder teile einen Tipp.
Beiträge hier stammen von Nutzern, nicht vom PopNx-Team.
Noch keine Bewertungen
Verglichen mit allen aktiven Servern dieser Kategorie in der Registry. Sterne zählen nur, wenn dem Herausgeber das Repo gehört.
Er hat 3 von 3 zutreffenden Basischecks bestanden. Den Code haben wir nicht gelesen. Bevor du einen Schlüssel oder Token hinzufügst, sieh nach, welche Zugriffe der Server verlangt, und nutze einen Schlüssel, der nur die Berechtigungen hat, die du brauchst.
Die Registry nennt keinen erforderlichen Schlüssel, manche Server bitten dich aber bei der ersten Nutzung, dich anzumelden.
Er läuft auf deinem Computer. Deine KI-App startet ihn bei Bedarf, und die Daten laufen nicht über die Server des Entwicklers (außer der Server ruft selbst einen Onlinedienst auf).
Das GitHub-Repo wurde zuletzt vor 39 Tagen geändert, und die neueste Version (0.3.0) kam vor 4 Monaten in die Registry.
Apps, die MCP unterstützen, etwa Claude Desktop, Claude Code, Cursor und VS Code. Außerdem brauchst du Python (uv) auf deinem Computer.
In derselben Kategorie: World Monitor, openstatus, Oh My Posh Validator, Strata, Jitsu
Gleiche Kategorie, andere Entwickler, Befehle bereits geprüft. Offizielle zuerst, dann nach Sternen.
So liest du eine Karte:↓ Downloads pro Wochei★ GitHub-SterneiDrei Säulen: Bewertungen · Checks · NutzungiAktualisiert = neueste Version in der Registry veröffentlichti
Real-time global intelligence on conflict, markets, energy, trade, shipping and cyber. 97 tools.
Manage monitors, status pages, incidents and maintenances in your openstatus workspace.
Validate oh-my-posh configurations and segment snippets against the official schema.
MCP server for progressive tool usage at any scale (see https://klavis.ai)
Manage Jitsu data pipelines: destinations, streams, connections, functions, live events.
| Dieser Qiskit Documentation MCP Server | World Monitor | openstatus | Oh My Posh Validator | Strata | Jitsu | |
|---|---|---|---|---|---|---|
| Läuft wo | Wird auf deinem Rechner installiert | Läuft in der Cloud, keine Installation | Läuft in der Cloud, keine Installation | Läuft in der Cloud, keine Installation | Läuft in der Cloud, keine Installation | Läuft in der Cloud, keine Installation |
| Braucht Schlüssel | Nein | Nein | Nein | Nein | Nein | Nein |
| Mit + in Claude hinzufügen | Nein | Nein | Nein | Nein | Nein | Nein |
| Basisprüfungen | 3/3 | 4/4 | 4/4 | 4/4 | 1/4 | 4/4 |
| Lizenz | Apache-2.0 | AGPL-3.0 | AGPL-3.0 | MIT | Apache-2.0 | MIT |
| Preis | Keine Kosten im Register | Keine Kosten im Register | Keine Kosten im Register | Keine Kosten im Register | Keine Kosten im Register | Keine Kosten im Register |
Unverändert aus dem Repo des Entwicklers übernommen. PopNx MCP hat den Inhalt weder geprüft noch empfiehlt es ihn. HTML, Bilder und Skripte wurden entfernt. Links führen von dieser Website weg.
MCP server for querying and retrieving Qiskit documentation, guides, and API references.
The Qiskit Documentation MCP Server provides AI assistants and agents with seamless access to the complete Qiskit documentation ecosystem. It enables intelligent retrieval of SDK module documentation, implementation guides, and best practices through a standardized Model Context Protocol interface.
The server implements three tools for documentation access:
| Tool | Description | Parameters |
|---|
| search_docs_tool | Search the Qiskit documentation; returns short query-centered snippets by default so the response stays compact for repeated agent use | query: Search query string scope: Search scope filter — all (default), documentation, api, learning, tutorials top_k: Max results to return (default: 5, capped at 10) detail: snippet (default, short excerpt per result) or full (full page body — prefer get_page_tool for a single page) | | get_page_tool | Fetch any Qiskit documentation page and return as markdown | url: Full URL or relative path (e.g., guides/transpile, api/qiskit/circuit) max_length: Max characters to return (default: 20000, 0 for unlimited) offset: Character offset for pagination (default: 0) | | lookup_error_code_tool | Look up a Qiskit/IBM Quantum error code | code: 4-digit error code (e.g., 1002, 7001, 8004) |
The server provides six resources for listing available documentation. Content lists for modules, addons, guides, tutorials, and API packages are dynamically discovered from the documentation sitemap and cached, with hardcoded fallback values used when the sitemap is unreachable.
| Resource URI | Description |
|---|---|
qiskit-docs://modules | List of all Qiskit SDK modules with URL paths |
qiskit-docs://addons | List of Qiskit addon packages with URL paths |
qiskit-docs://guides | List of implementation guides and best practices |
qiskit-docs://tutorials | List of Qiskit tutorials with URL paths |
qiskit-docs://api-packages | List of API packages (runtime, transpiler, REST APIs, etc.) |
qiskit-docs://error-codes | List of Qiskit error code categories |
| Resource URI | Description |
|---|---|
qiskit-docs://modules/{module_name} | Documentation for a specific SDK module |
qiskit-docs://guides/{guide_name} | A specific implementation guide |
qiskit-docs://addons/{addon_name} | Documentation for a specific addon package |
The easiest way to install is via pip:
pip install qiskit-docs-mcp-server
Or using uvx (recommended):
uvx qiskit-docs-mcp-server
This project uses uv for virtual environments and dependencies management. If you don't have uv installed, check out the instructions in https://docs.astral.sh/uv/getting-started/installation/
git clone https://github.com/Qiskit/mcp-servers.git
cd mcp-servers/qiskit-docs-mcp-server
# This will create a virtual environment and install dependencies
uv sync
The server can be configured using environment variables:
| Variable | Description | Default |
|---|---|---|
QISKIT_DOCS_BASE | Base URL for Qiskit documentation | https://quantum.cloud.ibm.com/docs/ |
QISKIT_HTTP_TIMEOUT | HTTP request timeout in seconds | 10.0 |
QISKIT_DOCS_CACHE_TTL | Page cache TTL in seconds | 3600.0 |
QISKIT_SEARCH_CACHE_TTL | Search/JSON cache TTL in seconds | 300.0 |
QISKIT_SEARCH_BASE_URL | Search API base URL | https://quantum.cloud.ibm.com/ |
Create a .env file in the project directory:
# Optional: Customize documentation URLs
QISKIT_DOCS_BASE=https://quantum.cloud.ibm.com/docs/ QISKIT_HTTP_TIMEOUT=15.0 QISKIT_DOCS_CACHE_TTL=3600.0 QISKIT_SEARCH_CACHE_TTL=300.0
uv run qiskit-docs-mcp-server
The server will start and listen for MCP connections.
Add to your Claude Desktop configuration file:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": { "qiskit-docs": { "command": "uvx", "args": ["qiskit-docs-mcp-server"] } } }
Add to your Cline MCP settings:
{
"mcpServers": { "qiskit-docs": { "command": "uvx", "args": ["qiskit-docs-mcp-server"] } } }
Note: To run LangChain examples you will need to install the dependencies:
`bash
pip install langchain-mcp-adapters langchain-openai langgraph
`
import asyncio
from langchain_mcp_adapters.client import MultiServerMCPClient from langchain_openai import ChatOpenAI from langgraph.prebuilt import create_react_agent
async def main():
async with MultiServerMCPClient( { "qiskit-docs": { "command": "qiskit-docs-mcp-server", "args": [], "transport": "stdio", } } ) as client:
agent = create_react_agent( ChatOpenAI(model="gpt-4o"), client.get_tools(), )
response = await agent.ainvoke( {"messages": [("user", "How do I create a quantum circuit in Qiskit?")]} ) print(response"messages".content)
asyncio.run(main())
# Search returns short snippets (not full pages) — cheap to call inside an agent
result = await search_docs_tool("transpiler optimization") print(f"Showing {result['returned_results']} of {result['total_results']} matches") for item in result["results"]: print(f"- {item['title']}: {item['url']}") print(f" {item['snippet']}")
page = await get_page_tool(result"results"["url"]) print(page["documentation"])
Note (behavior change):
search_docs_toolnow returns short, query-centered
snippets by default and caps results to
top_k(default 5). In default
(
detail="snippet") mode each result carries asnippetfield — not the full
textbody — and is limited to `id, url, title, pageTitle, module, section,
snippet
. For the original behavior, passdetail="full"`: it restores each
result's full
textbody and all upstream fields and returns every match
by default (no
top_kcap) — an explicittop_kstill limits the count in
full mode but is not clamped to the snippet-mode ceiling. Prefer
get_page_tool
for a single page's full content.
total_resultsis the grand total of matches;
returned_resultsis the count actually returned (equal tototal_resultsin
full mode unless you set an explicit
top_k).
# Fetch circuit module API reference
result = await get_page_tool("api/qiskit/circuit") print(result["documentation"])
result = await get_page_tool("api/qiskit/circuit", max_length=5000) if result["has_more"]: next_page = await get_page_tool("api/qiskit/circuit", offset=result["next_offset"])
# Look up error code 1002
result = await lookup_error_code_tool("1002") print(result["details"])
| Module | Description |
|---|---|
circuit | Quantum circuit construction and manipulation |
quantum_info | Quantum information theory utilities |
transpiler | Circuit transpilation and optimization |
synthesis | Circuit synthesis algorithms |
dagcircuit | DAG representation of quantum circuits |
passmanager | Transpiler pass manager framework |
converters | Circuit format converters |
compiler | High-level compilation routines |
primitives | Sampler and Estimator primitives |
providers | Backend providers and job management |
result | Job result handling and analysis |
visualization | Circuit and result visualization |
qasm2 | OpenQASM 2.0 support |
qasm3 | OpenQASM 3.0 support |
qpy | Qiskit Python serialization format |
utils | General utility functions |
exceptions | Qiskit exception classes |
| Guide | Description |
|---|---|
quick-start | Get started with Qiskit |
construct-circuits | Build and manipulate quantum circuits |
transpile | Transpile circuits for target backends |
transpiler-stages | Understand transpiler pipeline stages |
configure-error-mitigation | Configure error mitigation for primitives |
configure-error-suppression | Configure error suppression techniques |
primitives | Use Sampler and Estimator primitives |
execution-modes | Job, session, and batch execution modes |
dynamic-circuits | Mid-circuit measurements and classical control |
functions | Overview of Qiskit Functions |
See the
qiskit-docs://guidesresource for the complete list of 30+ available guides.
Large documentation pages are automatically paginated. Use max_length and offset to control content retrieval:
# Fetch first 5000 characters
result = await get_page_tool("api/qiskit/circuit", max_length=5000)
result = await get_page_tool("api/qiskit/circuit", max_length=0)
All responses include rich metadata:
{
"status": "success", "url": "https://quantum.cloud.ibm.com/docs/api/qiskit/circuit", "documentation": "