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，确保将其添加到 PATH 中。
  • 安装完成后重新运行脚本。
• 未识别 Conda：
  • 如果没有 Python 3.10 或更高版本，请确保已安装 Anaconda 并将其添加到 PATH 中。
• 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 文件。