GPUtw 說明文件

AI 助理

讓 Claude Code、Codex CLI、Gemini CLI、Cursor、Copilot 或任何 MCP 用戶端幫你操作 GPUtw API。

更新到最新版

目前最新版是 Skill v1.1.1、MCP 伺服器 1.1.0(兩者版本號分開計算;版本說明)。更新方式取決於你當初怎麼安裝:

  • 外掛: 你在 Claude Code 執行過 /plugin install gputw@gputw。大多數人是這種。
  • npm: 你用 npx -y @gputw/mcp-server 加入了 MCP 伺服器。
  • Clone: 你執行過 git clone(Codex、Gemini、Cursor、Copilot,或手動安裝到 Claude Code)。

外掛,在 Claude Code 裡:

  1. 刷新外掛清單:/plugin marketplace update gputw
  2. 開啟 /plugin → Installed → gputw → Update now。
  3. 載入新版本:/reload-plugins(或開一個新的 session)。
範例
/plugin marketplace update gputw
# 接著 /plugin → Installed → gputw → Update now
/reload-plugins

# 或在 shell 一步完成:
claude plugin update gputw@gputw
Tip

只做第 1 步只會刷新清單,不會更新已安裝的外掛。不想每次手動更新的話,開啟一次自動更新即可:/plugin → Marketplaces → gputw → Enable auto-update。預設是關閉的。

npm(MCP 伺服器):重新啟動 MCP 用戶端,就會抓取最新版。若要確定執行的是哪個版本,請釘選版本號,每次更新時調高:

範例
claude mcp add gputw -s user -e GPUTW_API_KEY=gputw_live_xxx -- npx -y @gputw/[email protected]

Clone:在你 clone 的資料夾執行 pull,然後重新啟動用戶端。

範例
git -C ~/.gputw-skill pull            # 或你當初用的資料夾,例如 ~/.claude/skills/gputw、.gputw-skill

確認更新成功。 claude plugin list 會顯示外掛版本;clone 的版本在 SKILL.md 的 metadata.version;在 Claude Code 執行 /mcp 可看到 MCP 伺服器版本。外掛與 Skill 應為 1.1.1,MCP 伺服器為 1.1.0。完整說明請見 repository README 的「更新」一節。

這是什麼

GPUtw 提供一份公開的知識包「GPUtw Skill」,教 AI 程式助理使用這套 API——端點、驗證標頭、每個呼叫需要的權限範圍、如何輪詢部署直到執行中,以及結束後如何清理。支援 Claude Code、OpenAI Codex CLI、Google Gemini CLI、Cursor 與 GitHub Copilot,並附官方 MCP 伺服器(18 個型別化工具)給任何支援 MCP 的用戶端。安裝一次之後,你就能用自然語言要一台機器,不必自己寫這些呼叫。

github.com/GPUtw-ai/GPUtw-Skill——MIT 授權,純 Markdown 加一支 stdlib Python 客戶端;不會把你的金鑰送到任何地方。

Claude Code

建議用外掛安裝:一次拿到 Skill、斜線指令與 MCP 工具,API 金鑰存在 Claude Code 的安全儲存區。

範例
/plugin marketplace add GPUtw-ai/GPUtw-Skill
/plugin install gputw@gputw

手動安裝(只有 Skill,沒有 MCP 工具):

範例
git clone https://github.com/GPUtw-ai/GPUtw-Skill.git ~/.claude/skills/gputw

選用的斜線指令 /gputw-deploy、/gputw-monitor、/gputw-vault、/gputw-debug 外掛已內建;手動安裝則從 commands/ 複製到 ~/.claude/commands/。

Warning
兩種安裝方式請只選一種。外掛與 ~/.claude/skills/gputw 的手動安裝同名,Claude Code 會以外掛為準、略過手動那份。

MCP 伺服器

同一個 repository 也提供 @gputw/mcp-server:18 個結構化工具,涵蓋目錄(list-gpus、list-available-nodes、list-templates)、執行個體生命週期(create-instance、stop-instance、delete-instance、restart-instance)、即時狀態(狀態、用量、日誌、事件)與 Vault(列表、統計、上傳、Hugging Face / URL 下載)。工具標註 read / write / destructive,API 錯誤會翻成可行動的訊息。

範例
claude mcp add gputw -s user -e GPUTW_API_KEY=gputw_live_xxx -- npx -y @gputw/mcp-server@latest

不想用 npm?伺服器也已預先建置在 repository 裡,可以改從 clone 下來的資料夾執行:

範例
git clone https://github.com/GPUtw-ai/GPUtw-Skill.git ~/.gputw-skill
claude mcp add gputw -s user -e GPUTW_API_KEY=gputw_live_xxx -- node ~/.gputw-skill/mcp/dist/stdio.mjs

Claude Desktop、Cursor、VS Code、Windsurf 等 MCP 用戶端使用同一個 stdio 伺服器:

範例
{
  "mcpServers": {
    "gputw": {
      "command": "npx",
      "args": ["-y", "@gputw/mcp-server@latest"],
      "env": { "GPUTW_API_KEY": "gputw_live_xxx" }
    }
  }
}

從 clone 執行時,改用 "command": "node" 與 "args": ["/絕對路徑/GPUtw-Skill/mcp/dist/stdio.mjs"]。

  • GPUTW_API_KEY: 除公開目錄外都需要。用最小權限的 preset。
  • GPUTW_API_BASE: 預設 https://api.gputw.ai/api。請維持 https——http 會被轉址,而用戶端在轉址時會丟掉金鑰。
  • GPUTW_MCP_ALLOW_EXEC: 容器內 root shell 工具 exec-in-instance 預設不註冊,設為 1 才會出現。

依賴工具前先確認真的連上:在 Claude Code 執行 /mcp,gputw 要顯示 Connected。工具根本沒出現就是伺服器沒連上——重跑安裝,或改用 Skill 的 curl / Python 指南。

Info
MCP 伺服器自 1.1.0 起為穩定版,與 Skill 一同發布。

OpenAI Codex CLI

把 repository clone 到專案(或全域),再在專案的 AGENTS.md 指向它。Codex 也支援原生 skills 目錄,放進去後可用 $gputw 明確呼叫。

範例
npm install -g @openai/codex

# 專案層級(建議)
git clone https://github.com/GPUtw-ai/GPUtw-Skill.git .gputw-skill
# 或放進 Codex 原生 skills 目錄,以 $gputw 呼叫
git clone https://github.com/GPUtw-ai/GPUtw-Skill.git .agents/skills/gputw
# 或全域
git clone https://github.com/GPUtw-ai/GPUtw-Skill.git ~/.codex/gputw-skill

在專案根目錄的 AGENTS.md 加入:

範例
## GPUtw Skill
遇到 GPUtw / gputw.ai / /vault / gputw_live_ 相關需求時,讀取 .gputw-skill/AGENTS.md(入口)與 .gputw-skill/SKILL.md(完整知識庫)。
指南在 .gputw-skill/guides/,端點清單在 .gputw-skill/references/endpoints.md,官方文件 URL 在 .gputw-skill/references/docs-site.md。

驗證:codex "GPUtw API key 的前綴是什麼?" 應回答 gputw_live_。

Google Gemini CLI

範例
npm install -g @google/gemini-cli
git clone https://github.com/GPUtw-ai/GPUtw-Skill.git .gputw-skill   # 或 ~/.gemini/gputw-skill

在專案 GEMINI.md 加入:

範例
## GPUtw Skill
遇到 GPUtw 相關需求時,讀取 .gputw-skill/GEMINI.md(入口)與 .gputw-skill/SKILL.md。

驗證:gemini "GPUtw API key 的前綴是什麼?" → gputw_live_。

Cursor 與 GitHub Copilot

Cursor:把 repository clone 到 .gputw-skill,在專案 AGENTS.md(或 Cursor Rules)加入與 Codex 相同的指引區塊。Cursor 會自動讀取 .gputw-skill/SKILL.md;查官方頁面時用 @web。Cursor 也能用上面的 JSON 接上 MCP 伺服器。

GitHub Copilot(VS Code Copilot Chat、Copilot CLI、Visual Studio):clone 到 .gputw-skill,建立 .github/copilot-instructions.md,要求 Copilot 先讀 .gputw-skill/SKILL.md、依決策樹讀 guides/、只引用 references/endpoints.md 列出的端點、可執行範例以 scripts/gputw_client.py 為基底。完整檔案內容見 repository 的 SETUP.md。

Claude.ai 與 Claude API:把資料夾壓成 zip,在 Settings → Features → Skills 上傳;SKILL.md 的 frontmatter 只用規範允許的欄位,可直接上傳。

任何支援 Agent Skills 格式(SKILL.md + references/ + scripts/)的代理程式,把資料夾放進其 skills 目錄即可。

它知道什麼

  • 驗證: gputw_live_ 金鑰、17 個 scopes 與 5 個 presets(含 CI 用的唯寫 Upload token)、金鑰放在哪個標頭,以及哪些事只能在控制台做。
  • GPU 清單: 讀取型錄、找出仍有餘裕的機器、售罄與排隊。
  • 執行個體: create(範本 / 自訂映像 / registryAuth / env / args)、狀態機、stop / delete / restart / reconfigure、SSH、OOM 與資料復原——包含最容易寫錯的等待邏輯。
  • 即時狀態: 狀態輪詢、用量與遙測來源、事件、前一個容器的日誌、exec、pod 重啟。
  • 網路: private / public / unlisted HTTP 連接埠、raw TCP/UDP 曝露、Web UI 交接網址、連接埠費。
  • Vault: 列表、單檔與可續傳的分段上傳(經 upload.gputw.ai)、伺服器端 URL / Hugging Face 下載、ComfyUI 模型目錄。
  • 帳務、團隊與除錯: 一小時餘額規則與 402、團隊成員限制、通知、工單,以及 401 / 403 / 409 / 429 與 Cloudflare 403 的「狀態碼 → 原因 → 動作」。

確認已載入

問助理:「GPUtw API key 的前綴是什麼?」——回答 gputw_live_ 即表示 Skill 已生效。再試一個真實需求:

範例
用 Python 幫我在 GPUtw 開一台 RTX 4090 跑 PyTorch 範本,等它 RUNNING 後印出 SSH 指令,最後一定要關機。

載入成功的助理會先查 /gpus/active 與 /nodes/available、用 /templates 找範本、以 /status 輪詢、在 finally 呼叫 /instances/stop,並列出所需 scopes。

金鑰與基底網址

到控制台 → API 金鑰,用最小權限的 preset 建立金鑰,只透過環境變數 GPUTW_API_KEY 交給助理。Skill 的規則禁止把金鑰放進 query string、寫死在程式碼或印在日誌,且 instances:exec 只給專用金鑰。

API 基底網址是 https://api.gputw.ai/api(只用 https),金鑰放 Authorization: Bearer gputw_live_…,每個請求帶 User-Agent。不需金鑰就能試的端點:/gpus/active、/templates、/config/time。

檢查它寫出來的程式

這個 skill 是獨立的 repository,有自己的發布節奏,因此可能落後於本 API 的變更。請把產生的程式當作草稿:在對正式帳號執行之前,先對照本文件確認它產生的呼叫,尤其留意任何會停止或刪除執行個體的操作。要固定版本:cd ~/.claude/skills/gputw && git tag -l && git checkout v1.0.0。問題請開 GitHub Issue——請勿在 issue 中貼上 API 金鑰。