仅在使用时加载搜索。在下方浏览所有类别。

开发者文档

安装 SosoAPI:软件包、客户端与远程 MCP

使用本地软件包或托管 MCP 将 agent 连接至 SosoAPI。本指南涵盖安装、连接检查和更新。

阅读 Markdown

由 SosoAPI 团队审核 ·

我该安装哪个 npm 套件?

新设置请安装 sosoapi。@sosoapi/cli、sosoapi-cli 及 sosoapi-mcp 是安装相同确切版本 sosoapi 的别名。它们执行相同 CLI 与 MCP 工具,因此只需一个套件。

本地 MCP 需要 Node.js 20 或更新版本及 npm/npx。托管 MCP 不需本地套件。安装或链接后,请登录以授予账号访问权限。

npm 发行套件
软件包用途命令
sosoapi标准 CLI 与 MCP 服务器npx -y sosoapi --help
@sosoapi/clisosoapi 的确切版本别名npx -y @sosoapi/cli --help
sosoapi-clisosoapi 的确切版本别名npx -y sosoapi-cli --help
sosoapi-mcpsosoapi 的确切版本别名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 sosoapi
codex 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 status
npx sosoapi api contract --route /identity-api/workspace/list --summary

更新或固定版本

运行 npx -y sosoapi@latest --help 获取当前 CLI,然后重启 MCP 客户端。如客户端保存了命令,请在 args 中放入所需版本。别名始终绑定其确切的 sosoapi 版本;更新独立的全局安装不会更新这些别名。

如出现版本偏差错误,比较已安装契约与所需操作。在 MCP 客户端实际使用的命令中更新软件包,重新连接并再次尝试该操作。schema 不匹配不需要新凭证或更广访问权限。

npx -y sosoapi@latest --help
npx sosoapi api contract --summary