QASM Submitter

You use the MCP server to efficiently invoke spinq's quantum hardware resources from AI models. This server acts as a bridge between your client and the SpinQ cloud, enabling automated submission of quantum tasks and retrieval of results with sensible, repeatable configurations.

How to use

Configure a local MCP client to talk to the qasm_submitter end point of the spinqit_mcp_tools MCP server. You will run a small, CLI-driven or IDE-integrated server launcher that starts a Python-based submitter process and exposes an endpoint for your MCP client to invoke. The submission tool reads environment variables for your private key and SpinQ Cloud username, so your credentials stay separate from your main code. Use the provided environment keys when you set up your client.

How to install

Prerequisites you need before installation.

• Python 3.10 or higher is required.
• Conda is optional if you do not have Python 3.10 installed; you can use Conda to create a suitable environment.
• An active internet connection is needed to install dependencies.
• On macOS, ensure your terminal has bash support.

Windows installation steps.

1. Download the Windows script mcpenv-installer-win-x86_64.bat and run it by double-clicking. 2) If Python 3.10 or higher is already installed, the script installs spinqit_mcp_tools and outputs the Python environment path and the mcp-server run command. 3) If Python 3.10 is not installed but Conda exists, the script creates a Conda environment named mcp-server-py310, installs dependencies, and outputs the environment path and run command. 4) If neither Python 3.10 nor Conda exists, the script prompts you to install Python 3.10 or Conda; after installation, rerun the script.

macOS installation steps.

1. Download the macOS script mcpenv-installer-mac.sh. 2) Run it with sudo bash ./mcpenv-installer-mac.sh. 3) The script checks for Python 3.10 or higher and installs spinqit_mcp_tools if found. If Python 3.10 is missing, it checks for Conda and creates a mcp-server-py310 environment. If neither is present, it prompts you to install Python 3.10 or Conda and rerun the script.

Manual installation steps.

1. Install Python 3.10 or higher, then run: pip install spinqit_mcp_tools. 2) Configure your client to run the mcp-server startup command: python -m spinqit_mcp_tools.qasm_submitter.

Configuration and example usage

{
  "mcpServers": {
    "qasm_submitter": {
      "type": "stdio",
      "command": "cmd",
      "args": [
        "/C",
        "C:\\Users\\ylin\\.conda\\envs\\mcp-server-py310\\python.exe",
        "-m",
        "spinqit_mcp_tools.qasm_submitter"
      ],
      "env": {
        "PRIVATEKEYPATH":"<Your Privatekey Path>",
        "SPINQCLOUDUSERNAME":"<Your SpinQ Cloud Username>"
      }
    }
  }
}

Troubleshooting

If Python is not found or is below 3.10, install Python 3.10 from the official site and rerun the installer or your manual setup.

If Conda is not recognized, ensure Anaconda is installed and added to PATH before proceeding with environment creation.

If pip installation fails, verify your internet connection and try again.

If creating a Conda environment fails, reinstall Conda from Anaconda’s official source and retry.

Notes and security

Store credentials in the environment (PRIVATEKEYPATH and SPINQCLOUDUSERNAME) and do not hard-code them into your client applications. Run the mcp-server process with the appropriate environment configuration, then point your MCP client to the standard stdio-based submission channel.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Available tools

qasm_submitter

Submits 2-qubit QASM circuits to the SpinQ cloud and returns results.