Quantum Simulator

🚀 Quantum Simulator MCP Server

A Docker image providing a quantum circuit simulator supporting the Model Context Protocol (MCP), which can be integrated with MCP clients such as the desktop version of "Claude".

✨ Features

• A quantum computing simulator supporting noise models.
• Support for OpenQASM 2.0 quantum circuits.
• Quantum circuit simulation using Qiskit.
• Support for multiple noise models (depolarizing, thermal relaxation, readout error).
• Multiple result types, including counts, state vectors, and visualized histograms.
• Pre - configured example circuits.
• Seamless integration with MCP clients.

🚀 Quick Start

Get the Docker image:

docker pull ychen94/quantum-simulator-mcp:latest

Run the container with the following command:

docker run -i --rm -v /tmp:/data/quantum_simulator_results -e HOST_OUTPUT_DIR="/tmp" ychen94/quantum-simulator-mcp:latest

This command:

• Mounts the host's /tmp directory to the container's /data/quantum_simulator_results.
• Sets the HOST_OUTPUT_DIR environment variable to /tmp.
• Keeps the container running in interactive mode (-i).
• Automatically deletes the container after it exits (--rm).

💻 Integration with Desktop Claude

1. Install the desktop version of Claude.
2. Edit the configuration file:
   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json
3. Add the following configuration to the mcpServers section:

{
  "mcpServers": {
    "quantum-simulator": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-v /tmp:/data/quantum_simulator_results",
        "-e HOST_OUTPUT_DIR=/tmp",
        "ychen94/quantum-simulator-mcp:latest"
      ]
    }
  }
}

🛠️ MCP Tools

• run_circuit: Run a quantum circuit.
• list_noise_models: List the supported noise models.
• get_result: Get the calculation result.
• visualize_circuit: Visualize the circuit.
• save_circuit: Save the circuit configuration.

📦 Resources

• Example circuits include the Bell state, Grover's algorithm, and the Deutsch - Jozsa algorithm.
• Pre - configured noise models support depolarizing and thermal noise.

💻 Usage Examples with Claude

Basic Usage

1. Launch the desktop version of Claude.
2. Enter the following prompt:

/quantum/simulator run_circuit "Circuit Name"

Advanced Usage

3. Use the visualize_circuit command to view the quantum circuit structure:

/quantum/simulator visualize_circuit "Circuit Name"

⚠️ Important Note

• The image paths have been adjusted to Chinese descriptions.
• Refer to the project code for specific implementation details.

🗂️ Volume Mapping

• /tmp: Used to store intermediate results and output files, and is default - mounted to the container's /data/quantum_simulator_results.

⚙️ Environment Variables

• HOST_OUTPUT_DIR: Specify the output directory to ensure it matches the volume mapping path.

🌐 Multi - Architecture Support

• Supported platforms include: linux/amd64 and linux/arm64.
• Suitable for CPUs with amd64 and arm64 architectures.

🚑 Troubleshooting

1. The container exits immediately:
   • Ensure that the -i flag is used to keep the standard input open, which is required for MCP STDIO transport.
2. The output directory is not found:
   • Check if HOST_OUTPUT_DIR is correctly set and matches the volume mapping path.

📄 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file in the project repository.