spinqit_mcp_tools Installation Guide

<div align="right"> <a href="README_zh.md">中文</a> | <a href="README.md">English</a> </div> This project is based on mcp-server to support efficient invocation of spinq's quantum computing hardware resources by AI large models.

This project provides one-click installation scripts for spinqit_mcp_tools on Windows and macOS. These scripts automatically check the Python environment (requires Python 3.10 or higher) and install the required spinqit_mcp_tools dependency package. If no suitable Python environment is found, the scripts will attempt to create one using Conda or guide users to manually install Python.

Table of Contents

• Prerequisites

• Manual Installation

• Script Installation Steps

  • Windows

  • macOS

  • Output Results

  • Troubleshooting

• cursor

• vscode-cline

• License

Prerequisites

Before running the installation scripts, ensure the following requirements are met:

• Python 3.10 or higher: spinqit_mcp_tools requires Python 3.10 or later.

• Conda (optional): If Python 3.10 is not installed, the scripts can use Anaconda to create an environment. Download it from Anaconda.

• Internet connection: Required for downloading the spinqit_mcp_tools package via pip.

• macOS terminal permissions: Ensure the terminal supports bash.

Manual Installation

If you prefer not to use the script for installation, you can manually install spinqit_mcp_tools. Follow the steps below. The only difference is that the script installation will display your Python path and the full command to launch the program at the end, which is helpful for beginners to configure:

• ​​Install Python 3.10 or later​​:

  • Download and install Python 3.10 or later from the Python official website. Alternatively, use Anaconda to install Python.

• ​​Install spinqit_mcp_tools​​:

  • Open a terminal or command prompt and run the following command:

      pip install spinqit_mcp_tools
    

• Verify successful installation:

  • In the terminal or command prompt, run the following command to check if it executes successfully:

      python -m spinqit_mcp_tools.qasm_submitter
    

  • If you see the message "FastMCP initialized successfully, Tool registered," the installation was successful.

• ​​Configure the MCP server​​:

Script Installation Steps

Windows

1. Download the Script

   • Download the mcpenv-installer-win-x86_64.bat script from the following link:

     <a href="https://static-cdn.spinq.cn/mcp_server_cmd/download_cmd.html?win">Download Windows Installation Script</a>

2. Run the Script

   • Double-click mcpenv-installer-win-x86_64.bat to execute the installation.

3. Script Behavior

   • If Python 3.10 or higher is already installed: The script will directly install the spinqit_mcp_tools package and output the Python environment path and the mcp-server execution command.

   • If Python 3.10 is not installed but Conda is available: The script will create a Conda environment named mcp-server-py310 (using Python 3.10), install the dependencies, and output the environment path and execution command.

   • If neither Python 3.10 nor Conda is installed: The script will prompt you to download and install Python 3.10 or Conda from Python's official website or Anaconda's official website. After installation, rerun the script.

4. Successful Installation

   • 

   • Note the execution command (e.g., C:\ProgramData\Anaconda3\envs\mcp-server-py310\python.exe -m spinqit_mcp_tools.qasm_submitter in this example) and register an account at cloud.spinq.cn to configure your public key.

   • input the execution command, PRIVATEKEYPATH , SPINQCLOUDUSERNAME to your mcp server setting

macOS

1. Download the Script

   • Download the mcpenv-installer-mac.sh script from the following link:

     <a href="https://static-cdn.spinq.cn/mcp_server_cmd/download_cmd.html?mac">Download macOS Installation Script</a>

2. Run the Script

   • Execute the script with:

     sudo bash ./mcpenv-installer-mac.sh
     

3. Script Behavior

   • Similar to the Windows script, the macOS script will:

     • Check for Python 3.10 or higher. If found, it will install spinqit_mcp_tools.

     • If Python 3.10 is not found, it will check for Conda and create a mcp-server-py310 environment.

     • If neither Python 3.10 nor Conda is installed, it will prompt you to install Python 3.10 or Conda and then rerun the script.

Output Results

After successful execution, the script will output the following information:

• Python environment path: The path to the Python executable, e.g.:

  • Windows: C:\path\to\conda\envs\mcp-server-py310\python.exe

  • macOS: /path/to/conda/envs/mcp-server-py310/bin/python

• mcp-server execution command: The command to run mcp-server, e.g.:

  • Windows: C:\path\to\conda\envs\mcp-server-py310\python.exe -m spinqit_mcp_tools.qasm_submitter

  • macOS: /path/to/conda/envs/mcp-server-py310/bin/python -m spinqit_mcp_tools.qasm_submitter

Save this information for configuring and running spinqit_mcp_tools.

Troubleshooting

• Python not found or version below 3.10:

  • Download and install Python 3.10 from Python's official website, ensuring it is added to PATH.

  • Rerun the script after installation.

• Conda not recognized:

  • Ensure Anaconda is installed and added to PATH if Python 3.10 or higher is not present.

• pip installation failure:

  • Check your internet connection.

• Conda environment creation failure:

  • Verify Conda is properly installed or reinstall it from Anaconda's official website.

Usage

• Use the Python installation directory to run:

  • /pathtopython/python -m spinqit_mcp_tools.qasm_submitter

Environment Testing (Create and submit a 2-qubit quantum circuit QASM to the cloud platform and view results)

• Cursor

  • Configuration method

  

  • Results

  

  • Configuration settings

    {
      "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>"
          }
        }
      }
    }
    

• VSCode Client Plugin

  • Configuration settings:

    {
      "mcpServers": {
        "qasm-submitter": {
          "disabled": false,
          "timeout": 60,
          "transportType": "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>"
          }
        }
      }
    }
    

  • Configuration method

  

  • Results

  

License

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