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 文件。