Quantum Simulator

🚀 Quantum Simulator MCP Server

A Docker image providing a quantum circuit simulator implementing the Model Context Protocol (MCP), supporting integration with MCP clients such as the desktop version of Claude.

🚀 Quick Start

Pull the Docker Image

docker pull ychen94/quantum-simulator-mcp:latest

Run the Container

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.
• Runs the container in interactive mode (-i).
• Automatically deletes the container after it exits (--rm).

✨ Features

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

💻 Usage Examples

1. Download and install Docker.
2. Pull the image: docker pull ychen94/quantum-simulator-mcp:latest
3. Run the container: docker run -i --rm -v /tmp:/data -e HOST_OUTPUT_DIR="/tmp" ychen94/quantum-simulator-mcp:latest
4. Interact with the simulator using the CLI or an integrated development environment.

📚 Documentation

Integration with Desktop Claude

1. Install the desktop version of Claude.
2. Edit the Claude 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"
      ]
    }
  }
}

4. After configuration, restart or reconnect the Claude client to apply the changes.

MCP Tools

• run_circuit: Simulate a quantum circuit and return the results.
• get_state: Get the current state of the quantum system.
• set_params: Configure the parameters of the quantum circuit.
• measure: Measure the system and output the results.

Resources

• Example Files:
  • examples/circuits/hello_world.qasm: An example of a basic quantum circuit.
  • examples/configurations/default.json: The default MCP configuration file.

❗ Troubleshooting

• Problem: The Docker container exits immediately.
  • Solution: Ensure that the -i flag is used to keep the standard input open, which is required for MCP STDIO transportation.

📄 License

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