Qiskit Code Assistant MCP Server
平台与服务by qiskit
为 Qiskit Code Assistant 提供智能代码补全能力的 MCP Server。
什么是 Qiskit Code Assistant MCP Server?
为 Qiskit Code Assistant 提供智能代码补全能力的 MCP Server。
README
Qiskit MCP Servers
A collection of Model Context Protocol (MCP) servers that provide AI assistants, LLMs, and agents with seamless access to IBM Quantum services and Qiskit libraries for quantum computing development and research.
🌟 What is This?
This repository contains production-ready MCP servers that enable AI systems to interact with quantum computing resources through Qiskit. Instead of manually configuring quantum backends, writing boilerplate code, or managing IBM Quantum accounts, AI assistants can now:
- 🤖 Generate intelligent quantum code with context-aware suggestions
- 🔌 Connect to real quantum hardware automatically
- 📊 Analyze quantum backends and find optimal resources
- 🚀 Execute quantum circuits and monitor job status
- 💡 Provide quantum computing assistance with expert knowledge
🛠️ Available Servers
🔬 Qiskit MCP Server
Core Qiskit quantum computing capabilities
Provides quantum circuit creation, manipulation, transpilation, and serialization utilities (QASM3, QPY) for local quantum development using Qiskit
📁 Directory: ./qiskit-mcp-server/
🧠 Qiskit Code Assistant MCP Server
Intelligent quantum code completion and assistance
Provides access to IBM's Qiskit Code Assistant for AI-assisted quantum programming
📁 Directory: ./qiskit-code-assistant-mcp-server/
⚙️ Qiskit IBM Runtime MCP Server
Complete access to IBM Quantum cloud services
Comprehensive interface to IBM Quantum hardware via Qiskit IBM Runtime
📁 Directory: ./qiskit-ibm-runtime-mcp-server/
🚀 Qiskit IBM Transpiler MCP Server
AI-powered circuit transpilation
Access to the qiskit-ibm-transpiler library for AI-optimized circuit routing and optimization.
📁 Directory: ./qiskit-ibm-transpiler-mcp-server/
📚 Qiskit Documentation MCP Server
Qiskit documentation retrieval and search
Query and retrieve Qiskit documentation, guides, and API references. No authentication required.
📁 Directory: ./qiskit-docs-mcp-server/
🏋️ Community Servers
🏋️ Qiskit Gym MCP Server
Reinforcement learning for quantum circuit synthesis
Uses qiskit-gym to train RL models for optimal quantum circuit synthesis, including permutation routing, linear function synthesis, and Clifford circuits.
📁 Directory: ./qiskit-gym-mcp-server/
📚 Examples
Each MCP server includes example code demonstrating how to build AI agents using LangChain:
| Server | Examples |
|---|---|
| Qiskit MCP Server | qiskit-mcp-server/examples/ |
| Qiskit Code Assistant MCP Server | qiskit-code-assistant-mcp-server/examples/ |
| Qiskit IBM Runtime MCP Server | qiskit-ibm-runtime-mcp-server/examples/ |
| Qiskit IBM Transpiler MCP Server | qiskit-ibm-transpiler-mcp-server/examples/ |
| Qiskit Documentation MCP Server | qiskit-docs-mcp-server/examples/ |
| Qiskit Gym MCP Server (Community) | qiskit-gym-mcp-server/examples/ |
Each examples directory contains:
- Jupyter Notebook (
langchain_agent.ipynb) - Interactive tutorial with step-by-step examples - Python Script (
langchain_agent.py) - Command-line agent with multiple LLM provider support
Advanced: Quantum Volume Finder
The examples/ directory contains a multi-agent system that combines multiple MCP servers to find the highest achievable Quantum Volume for IBM Quantum backends through actual hardware execution. It demonstrates multi-server orchestration, local tool wrappers to keep large data out of the LLM context, and both single-circuit and full statistical protocol modes. See the examples README for details.
🚀 Quick Start
Prerequisites
- Python 3.10+ (3.11+ recommended)
- uv package manager (fastest Python package manager)
- IBM Quantum account and API token
- Qiskit Code Assistant access (for code assistant server)
Installation
Install from PyPI
# Install all MCP servers (core + community)
pip install qiskit-mcp-servers[all]
# Install just the core servers (default)
pip install qiskit-mcp-servers
# Install individual servers
pip install qiskit-mcp-servers[qiskit] # Qiskit server only
pip install qiskit-mcp-servers[code-assistant] # Code Assistant server only
pip install qiskit-mcp-servers[runtime] # IBM Runtime server only
pip install qiskit-mcp-servers[transpiler] # IBM Transpiler server only
pip install qiskit-mcp-servers[docs] # Documentation server only
pip install qiskit-mcp-servers[gym] # Qiskit Gym server only (community)
# Install community servers only
pip install qiskit-mcp-servers[community]
Install from Source
Each server is designed to run independently. Choose the server you need:
🔬 Qiskit Server
cd qiskit-mcp-server
uv run qiskit-mcp-server
🧠 Qiskit Code Assistant Server
cd qiskit-code-assistant-mcp-server
uv run qiskit-code-assistant-mcp-server
⚙️ IBM Runtime Server
cd qiskit-ibm-runtime-mcp-server
uv run qiskit-ibm-runtime-mcp-server
🚀 IBM Transpiler Server
cd qiskit-ibm-transpiler-mcp-server
uv run qiskit-ibm-transpiler-mcp-server
📚 Documentation Server
cd qiskit-docs-mcp-server
uv run qiskit-docs-mcp-server
🏋️ Qiskit Gym Server (Community)
cd qiskit-gym-mcp-server
uv run qiskit-gym-mcp-server
🔧 Configuration
Environment Variables
# For IBM Runtime Server
export QISKIT_IBM_TOKEN="your_ibm_quantum_token_here"
# For Code Assistant Server
export QISKIT_IBM_TOKEN="your_ibm_quantum_token_here"
export QCA_TOOL_API_BASE="https://qiskit-code-assistant.quantum.ibm.com"
Using with MCP Clients
All servers are compatible with any MCP client. Test interactively with MCP Inspector:
# Replace <server-name> with any server command
npx @modelcontextprotocol/inspector uv run qiskit-mcp-server
npx @modelcontextprotocol/inspector uv run qiskit-docs-mcp-server
npx @modelcontextprotocol/inspector uv run qiskit-ibm-runtime-mcp-server
# etc.
Claude Desktop / Cline Configuration
Add to your MCP client configuration (e.g., claude_desktop_config.json):
{
"mcpServers": {
"qiskit": {
"command": "uvx",
"args": ["qiskit-mcp-server"]
},
"qiskit-docs": {
"command": "uvx",
"args": ["qiskit-docs-mcp-server"]
},
"qiskit-runtime": {
"command": "uvx",
"args": ["qiskit-ibm-runtime-mcp-server"],
"env": {
"QISKIT_IBM_TOKEN": "your_ibm_quantum_token_here"
}
}
}
}
See each server's README for the full list of environment variables and configuration options.
🏗️ Architecture & Design
🎯 Unified Design Principles
All servers follow a consistent, production-ready architecture:
- 🔄 Async-first: Built with FastMCP for high-performance async operations
- 🧪 Test-driven: Comprehensive test suites with 65%+ coverage
- 🛡️ Type-safe: Full mypy type checking and validation
- 📦 Modern packaging: Standard
pyproject.tomlwith hatchling build system - 🔧 Developer-friendly: Automated formatting (ruff), linting, and CI/CD
🔌 MCP Protocol Support
All servers implement the full Model Context Protocol specification:
- 🛠️ Tools: Execute quantum operations (code completion, job submission, backend queries)
- 📚 Resources: Access quantum data (service status, backend information, model details)
- ⚡ Real-time: Async operations for responsive AI interactions
- 🔒 Secure: Proper authentication and error handling
🧪 Development
🏃♂️ Running Tests
# Run tests for any server
cd qiskit-code-assistant-mcp-server # or any server directory
./run_tests.sh
🔍 Code Quality
All servers maintain high code quality standards:
- ✅ Linting:
ruff checkandruff format - 🛡️ Type checking:
mypy src/ - 🧪 Testing:
pytestwith async support and coverage reporting - 🚀 CI/CD: GitHub Actions for automated testing
📖 Resources & Documentation
🔗 Essential Links
- Model Context Protocol - Understanding MCP
- Qiskit IBM Runtime - Quantum cloud services
- Qiskit Code Assistant - AI code assistance
- MCP Inspector - Interactive testing tool
- FastMCP - High-performance MCP framework
AI Development Assistant Support
This repository includes AI-generated code and offers comprehensive guidance for AI coding assistants (like IBM Bob, Claude Code, GitHub Copilot, Cursor AI, and others) in AGENTS.md. This helps AI assistants provide more accurate, context-aware suggestions when working with this codebase.
📄 License
This project is licensed under the Apache License 2.0.
常见问题
Qiskit Code Assistant MCP Server 是什么?
为 Qiskit Code Assistant 提供智能代码补全能力的 MCP Server。
相关 Skills
MCP构建
by anthropics
聚焦高质量 MCP Server 开发,覆盖协议研究、工具设计、错误处理与传输选型,适合用 FastMCP 或 MCP SDK 对接外部 API、封装服务能力。
✎ 想让 LLM 稳定调用外部 API,就用 MCP构建:从 Python 到 Node 都有成熟指引,帮你更快做出高质量 MCP 服务器。
Slack动图
by anthropics
面向Slack的动图制作Skill,内置emoji/消息GIF的尺寸、帧率和色彩约束、校验与优化流程,适合把创意或上传图片快速做成可直接发送的Slack动画。
✎ 帮你快速做出适配 Slack 的动图,内置约束规则和校验工具,少踩上传与播放坑,做表情包和演示都更省心。
MCP服务构建器
by alirezarezvani
从 OpenAPI 一键生成 Python/TypeScript MCP server 脚手架,并校验 tool schema、命名规范与版本兼容性,适合把现有 REST API 快速发布成可生产演进的 MCP 服务。
✎ 帮你快速搭建 MCP 服务与后端 API,脚手架完善、扩展顺手,尤其适合想高效验证服务能力的开发者。
相关 MCP Server
Slack 消息
编辑精选by Anthropic
Slack 是让 AI 助手直接读写你的 Slack 频道和消息的 MCP 服务器。
✎ 这个服务器解决了团队协作中需要 AI 实时获取 Slack 信息的痛点,特别适合开发团队让 Claude 帮忙汇总频道讨论或发送通知。不过,它目前只是参考实现,文档有限,不建议在生产环境直接使用——更适合开发者学习 MCP 如何集成第三方服务。
by netdata
io.github.netdata/mcp-server 是让 AI 助手实时监控服务器指标和日志的 MCP 服务器。
✎ 这个工具解决了运维人员需要手动检查系统状态的痛点,最适合 DevOps 团队让 Claude 自动分析性能数据。不过,它依赖 NetData 的现有部署,如果你没用过这个监控平台,得先花时间配置。
by d4vinci
Scrapling MCP Server 是专为现代网页设计的智能爬虫工具,支持绕过 Cloudflare 等反爬机制。
✎ 这个工具解决了爬取动态网页和反爬网站时的头疼问题,特别适合需要批量采集电商价格或新闻数据的开发者。不过,它依赖外部浏览器引擎,资源消耗较大,不适合轻量级任务。