RemoteGymp · API v1

連接AI助手

使用支援 Streamable HTTP 以及使用 PKCE 預先註冊 OAuth 或設定的承載令牌的 MCP 用戶端。客戶支援各不相同;自動客戶端註冊不可用。

MCP伺服器URL

https://api.remotegymp.com/mcp

對於自託管,請在安裝的公共 HTTPS 位址上使用相同的 MCP 路徑。您的客戶必須能夠達到目標。雲端位址不會代理對您的安裝的請求。

使用 OAuth 連接

  1. 在「設定」中,建立啟用了 MCP 且僅具有助理所需權限的憑證。註冊您的用戶端提供的確切回呼 URL。使用憑證使用者名稱作為 OAuth 用戶端 ID。此流程不使用客戶端密鑰。
  2. 回呼必須在明確環回位址上使用 HTTPS 或 HTTP。完整的 URL 必須匹配,包括連接埠。若要變更它,請建立新憑證並撤銷舊憑證。
  3. 從您的用戶端連接,以建立憑證的擁有者身分登入並查看同意畫面。用戶端必須使用 S256 PKCE 和 MCP 資源 URL。同意可以縮小憑證的權限;它無法新增權限。

雲端 OAuth 端點

授權
https://app.remotegymp.com/integration/oauth/authorize
代幣兌換
https://app.remotegymp.com/integration/oauth/token
授權伺服器元數據
https://app.remotegymp.com/.well-known/oauth-authorization-server
受保護的資源元數據
https://api.remotegymp.com/.well-known/oauth-protected-resource/mcp

OAuth 使用標準令牌欄位名稱和輪換刷新令牌。客戶端應該會自動處理刷新。訪問令牌最多持續 30 分鐘。連線在 7 天無刷新或總共 30 天後過期。重複使用舊的刷新令牌會使連線失效;重新連線而不是重播。

使用不記名令牌連接

如果您的用戶端支援設定的不記名令牌,請在令牌端點與 MCP 受眾交換啟用 MCP 的憑證,然後將傳回的令牌放入用戶端的安全不記名令牌設定中。 30 分鐘後過期。不要在伺服器 URL 中放置令牌。對於需要自動刷新的用戶端使用 OAuth。

{
  "username": "<your-credential-username>",
  "password": "<your-credential-secret>",
  "audience": "mcp"
}

認證 →

工作前檢查存取權限

要求客戶先列出其可用的工具和閱讀功能。從唯讀請求開始,例如列出裝置。缺少的工具可能反映權限、範圍或可用性。單獨啟用 MCP 並不能授予遠端控制權限。

tools/list · get_capabilities

螢幕觀看須經設備同意。螢幕輸入需要新的螢幕截圖。在批准工作之前審查目標、刪除預覽和引用的人工智慧成本。緊急停止阻止進一步的自動化;已經運行的工作可能會完成。

斷開連線或撤銷訪問

當不再需要時,在客戶端中斷開連線並在「設定」中撤銷該憑證。撤銷會在後續請求中停止其關聯的令牌和 OAuth 連線。切勿在不相關的整合之間共享憑證。

內容修訂3f225a253 · OpenAPI SHA-256: b12c42306a89