Spinqit MCP Tools

🚀 spinqit_mcp_tools安装指南

本项目基于mcp-server，支持AI大模型高效调用SpinQ的量子计算硬件资源。

本项目为Windows和macOS系统提供了spinqit_mcp_tools的一键安装脚本。这些脚本会自动检查Python环境（要求Python 3.10或更高版本），并安装所需的spinqit_mcp_tools依赖包。如果未找到合适的Python环境，脚本将尝试使用Conda创建一个环境，或引导用户手动安装Python。

📚 目录

• 前提条件
• 脚本安装步骤
  • Windows系统
  • macOS系统
  • 输出结果
  • 故障排除
• 手动安装步骤
• 许可证

📋 前提条件

在运行安装脚本之前，请确保满足以下要求：

• Python 3.10或更高版本：spinqit_mcp_tools需要Python 3.10或更高版本。
• Conda（可选）：如果未安装Python 3.10，脚本可以使用Anaconda创建环境。可从Anaconda官网下载。
• 网络连接：需要通过pip下载spinqit_mcp_tools包。
• macOS终端权限：确保终端支持bash。

📦 脚本安装步骤

💻 Windows系统

1. 下载脚本
   • 从以下链接下载mcpenv-installer-win-x86_64.bat脚本： 下载Windows安装脚本
2. 运行脚本
   • 双击mcpenv-installer-win-x86_64.bat执行安装。
3. 脚本行为
   • 若已安装Python 3.10或更高版本：脚本将直接安装spinqit_mcp_tools包，并输出Python环境路径和mcp-server执行命令。
   • 若未安装Python 3.10但有Conda：脚本将创建一个名为mcp-server-py310的Conda环境（使用Python 3.10），安装依赖项，并输出环境路径和执行命令。
   • 若既未安装Python 3.10也没有Conda：脚本将提示你从Python官网或Anaconda官网下载并安装Python 3.10或Conda。安装完成后，重新运行脚本。
4. 安装成功
   • 记录执行命令（例如本示例中的C:\ProgramData\Anaconda3\envs\mcp-server-py310\python.exe -m spinqit_mcp_tools.qasm_submitter），并在cloud.spinq.cn注册账户以配置公钥。
   • 将执行命令、PRIVATEKEYPATH和SPINQCLOUDUSERNAME输入到你的mcp服务器设置中。

🍎 macOS系统

1. 下载脚本
   • 从以下链接下载mcpenv-installer-mac.sh脚本： 下载macOS安装脚本
2. 运行脚本
   • 使用以下命令执行脚本：

     sudo bash ./mcpenv-installer-mac.sh
     

3. 脚本行为
   • 与Windows脚本类似，macOS脚本将：
     • 检查是否有Python 3.10或更高版本。如果找到，将安装spinqit_mcp_tools。
     • 如果未找到Python 3.10，将检查Conda并创建mcp-server-py310环境。
     • 如果既未找到Python 3.10也没有Conda，将提示你安装Python 3.10或Conda，然后重新运行脚本。

📤 输出结果

脚本成功执行后，将输出以下信息：

• Python环境路径：Python可执行文件的路径，例如：
  • Windows：C:\path\to\conda\envs\mcp-server-py310\python.exe
  • macOS：/path/to/conda/envs/mcp-server-py310/bin/python
• mcp-server执行命令：运行mcp-server的命令，例如：
  • 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

保存此信息，用于配置和运行spinqit_mcp_tools。

⚠️ 故障排除

• 未找到Python或版本低于3.10：
  • 从Python官网下载并安装Python 3.10，确保将其添加到系统路径中。
  • 安装完成后重新运行脚本。
• Conda未被识别：
  • 如果没有Python 3.10或更高版本，请确保已安装Anaconda并将其添加到系统路径中。
• pip安装失败：
  • 检查网络连接。
• Conda环境创建失败：
  • 验证Conda是否正确安装，或从Anaconda官网重新安装。

💻 使用方法

• 使用Python安装目录运行：
  • /pathtopython/python -m spinqit_mcp_tools.qasm_submitter

🧪 环境测试（创建一个2量子比特的量子电路QASM并提交到云平台，查看结果）

• 光标方式
  • 配置方法
  • 结果
  • 配置设置

    {
      "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客户端插件
  • 配置设置

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

  • 配置方法
  • 结果

🛠️ 手动安装步骤

• 安装Python 3.10或更高版本，然后运行：pip install spinqit_mcp_tools
• 配置python -m spinqit_mcp_tools.qasm_submitter作为mcp客户端启动命令。

📄 许可证

本项目采用MIT许可证。详情请参阅LICENSE文件。