開發者文件
安裝 SosoAPI:套件、用戶端與遠端 MCP
使用本機套件或託管 MCP 將代理程式連結至 SosoAPI。本指南涵蓋安裝、連結檢查和更新。
閱讀 Markdown由 SosoAPI 團隊檢閱 ·
我該安裝哪個 npm 套件?
新設定請安裝 sosoapi。@sosoapi/cli、sosoapi-cli 及 sosoapi-mcp 是安裝相同確切版本 sosoapi 的別名。它們執行相同 CLI 與 MCP 工具,因此只需一個套件。
本機 MCP 需要 Node.js 20 或更新版本及 npm/npx。託管 MCP 不需本機套件。安裝或連結後,請登入以授予帳號存取權。
| 套件 | 用途 | 命令 |
|---|---|---|
| sosoapi | 標準 CLI 與 MCP 伺服器 | npx -y sosoapi --help |
| @sosoapi/cli | sosoapi 的確切版本別名 | npx -y @sosoapi/cli --help |
| sosoapi-cli | sosoapi 的確切版本別名 | npx -y sosoapi-cli --help |
| sosoapi-mcp | sosoapi 的確切版本別名 | npx -y sosoapi-mcp --help |
連結本機 MCP 用戶端
使用下方命令加入 core 設定連結。如果 SosoAPI 已連結且正常工作,請保留該連結。不帶參數執行 sosoapi 會啟動 stdio MCP 伺服器;其會在 stdin 等待用戶端。
Claude Desktop、Cursor 或其他 stdio 用戶端,請在 MCP 設定中加入下方 JSON。設定位置與核准步驟依用戶端而異。必要時重新啟動或重新連結用戶端,再確認對話中可使用 SosoAPI 工具。
claude mcp add sosoapi -e SOSOAPI_TOOL_PROFILE=core -- npx -y sosoapicodex mcp add sosoapi --env SOSOAPI_TOOL_PROFILE=core -- npx -y sosoapi{
"mcpServers": {
"sosoapi": {
"command": "npx",
"args": [
"-y",
"sosoapi"
],
"env": {
"SOSOAPI_TOOL_PROFILE": "core"
}
}
}
}透過 OAuth 連結遠端 MCP
在支援遠端 MCP、OAuth 和動態用戶端註冊的用戶端中,加入下方 URL。透過瀏覽器登入,並選擇要允許的工作空間和操作。無需貼上 API key、client ID 或 client secret。透過 HTTP 提供媒體時,請匯入公開 URL;上傳本機檔案需要本機 MCP 伺服器。
ChatGPT 自訂應用程式與 Claude 遠端連接器,取決於您的方案與用戶端提供的連接器設定。這些說明用於設定自訂連線,不代表應用程式目錄上架。
https://gqeshlawtcexsapabaui.supabase.co/functions/v1/remote-mcp在不發布的情況下驗證設定
檢查身分驗證狀態,並隨選登入。讀取工作空間資訊和已連結帳號,然後確認回傳的帳號和工作空間符合預期。這可在不提交貼文的情況下驗證存取;發布仍取決於該帳號的權限。
完成設定無需發布測試貼文。使用現有內容繼續原始任務。使用者需完成平台同意,並在任何請求的寫入前審核目標、內容和時間。
npx sosoapi auth statusnpx sosoapi api contract --route /identity-api/workspace/list --summary更新或固定版本
執行 npx -y sosoapi@latest --help 取得目前 CLI,然後重新啟動 MCP 用戶端。如用戶端保存了命令,請在 args 中放入所需版本。別名始終繫結其確切的 sosoapi 版本;更新獨立的全域安裝不會更新這些別名。
如出現版本偏差錯誤,比較已安裝契約與所需操作。在 MCP 用戶端實際使用的命令中更新套件,重新連結並再次嘗試該操作。schema 不相符不需要新憑證或更廣存取權限。
npx -y sosoapi@latest --helpnpx sosoapi api contract --summary