mcpField
S
Soracom Knowledge

Soracom Knowledge

远程服务
docs.soracom.io开发工具43 周前更新

关于 Soracom Knowledge

Soracom Knowledge 是由 Soracom 托管的只读 MCP 服务,供 Agent 在开发环境中检索官方文档和 API 参考。它结合关键词与语义搜索,并可获取搜索命中页面的完整 Markdown。

主要功能

  1. 01检索服务指南、价格与 IoT 配方
  2. 02搜索 API、CLI 命令和 SAM 权限
  3. 03关键词与语义混合搜索
  4. 04获取页面完整 Markdown

适用场景

  1. 01查找 Soracom 服务配置步骤
  2. 02查询 API 端点或 CLI 用法
  3. 03核对定价及 SAM 权限说明

MCP 相关

该 MCP 服务通过 Streamable HTTP 向客户端提供三个只读工具:文档搜索、API 文档搜索和页面获取。它只检索公开的 Soracom 文档,不会修改账户资源。

配置

远程服务无需本地安装。选择你使用的客户端,复制配置或使用一键安装。

服务地址https://knowledge-mcp.soracom.com
一键复制安装命令
Claude CodeTerminal
Cursor.cursor/mcp.json
VS Code.vscode/mcp.json
Claude Desktopclaude_desktop_config.json
Windsurf~/.codeium/windsurf/mcp_config.json

命令在终端中运行;JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。

工具

3
参数类型必填说明
urlstring是搜索结果 URL,或 search_api_docs 中 `#/schema/<Name>` 链接的完整 URL。必须以 http:// 或 https:// 开头;请原样传入。

详细介绍

Soracom Knowledge MCP 服务

Soracom Knowledge MCP 服务是一个 MCP(Model Context Protocol) 服务,可让 AI Agent 直接从开发环境中搜索 Soracom 文档和 Soracom API 参考。连接到 Claude Code、OpenAI Codex 或 Claude Desktop 等 MCP 客户端后,Agent 可以按需查找服务指南、Soracom 用户控制台操作流程、定价、IoT 配方、Soracom API 参考、CLI 命令和 SAM 权限,并依据官方文档提供有据可查的回答,而不只是依赖训练数据。

该服务由 Soracom 托管,是一个共享的只读端点。它不会修改你的任何 Soracom 资源——Agent 只会搜索和读取文档。

可用工具

该服务向已连接的 Agent 提供三个只读工具。它们都不会修改你的账户或资源。

该服务默认使用 hybrid 搜索模式,将关键词搜索与语义搜索(使用 OpenAI 嵌入)结合,并通过 Reciprocal Rank Fusion(RRF)合并结果。

search_soracom_docs

搜索 Soracom 服务指南、Soracom 用户控制台操作流程、服务概览和定价,以及 IoT 配方。

参数说明
query自然语言搜索查询(必填)。
document_names将搜索范围限制为指定站点(例如,["docs.soracom.io", "users.soracom.io"])。可用站点列在工具架构中。省略此参数可搜索所有来源。
search_modehybrid(默认;结合关键词搜索和语义搜索)、keyword(仅关键词搜索)或 semantic(仅语义相似度搜索)。
languageEnglish 或 Japanese。省略时根据查询自动检测。
max_results返回结果数。默认值为 16,最大值为 32。
search_api_docs

搜索 Soracom API 参考、CLI 命令和 SAM 权限。

参数说明
query自然语言问题或 API 端点名称。提供 tag、method 或 path 中至少一项时,此参数可选。
tag将结果限制为某个服务标签(例如,Sim、Subscriber、Flux)。精确匹配,不区分大小写。
method将结果限制为某个 HTTP 方法(例如,GET、POST)。精确匹配,不区分大小写。
path将结果限制为包含指定 API 路径片段的结果(例如,/sims)。子字符串匹配,不区分大小写。
search_modehybrid(默认;结合关键词搜索和语义搜索)、keyword(仅关键词搜索)或 semantic(仅语义相似度搜索)。
languageEnglish 或 Japanese。提供 query 时,根据 query 自动检测。若省略 query,请明确指定 language。
max_results返回结果数。默认值为 16,最大值为 32。
get_document

获取由 search_soracom_docs 或 search_api_docs 返回页面的完整 Markdown 内容。

参数说明
url要获取页面的 URL(必填)。请原样传入搜索结果中的 url 值。搜索结果可能会返回无法直接在浏览器中查看的 URL(例如拆分后的 API 参考中的某个片段),但此工具仍可获取其内容。

连接服务

该服务可通过稳定的公共 HTTPS 端点访问,并使用 MCP Streamable HTTP 传输:

https://knowledge-mcp.soracom.com

警告

该服务没有针对单个用户的身份验证功能。它只会搜索并返回公开的 Soracom 文档,但你输入的任何查询都会发送到该端点。使用 hybrid 或 semantic 搜索模式时,你的查询还会发送到 OpenAI 以生成嵌入。请勿在查询中包含机密信息、账户标识符、凭据或个人数据。

有关 Soracom 的条款和隐私惯例,请参阅条款与条件和隐私政策。Soracom 不会在服务日志中记录或保留你的查询内容。Soracom 也不会将 OpenAI API 的输入或输出提供给 OpenAI 用于模型改进、评估、微调或训练。详情请参阅 OpenAI 的商业数据隐私、安全与合规。

使用本服务须遵守我们的网站政策(提供日语版本),其中包含免责声明、版权条款,并规定使用行为受日本法律管辖,且东京地方法院为一审专属管辖法院。以日语文本为准。

Claude Code

Claude Code 原生支持远程 HTTP MCP 服务。使用 claude mcp add 命令添加服务:

claude mcp add --transport http soracom-knowledge https://knowledge-mcp.soracom.com

验证服务是否已连接:

claude mcp list

soracom-knowledge 服务及其三个工具现在已可在 Claude Code 会话中使用。以后如需移除,请运行 claude mcp remove soracom-knowledge。

OpenAI Codex

Codex CLI 支持通过 HTTP 连接远程 MCP 服务。使用以下命令添加服务:

codex mcp add soracom-knowledge --url https://knowledge-mcp.soracom.com

列出已配置的服务以确认:

codex mcp list

说明与限制

  • 本服务免费提供,尽力维护,但不提供 SLA。随着服务改进,其规格可能会在不另行通知的情况下发生变化。
  • 如果检测到请求数量过多,访问权限可能会暂时受到限制。
  • 结果集可能包含与查询仅有较弱关联的页面。预期由 Agent 对其进行筛选;请将单条结果视为候选项,而非权威匹配结果。
  • 本服务返回的信息按“原样”提供,AI Agent 生成的答案不保证准确。请对照链接的源页面核实重要信息。
  • 搜索索引会定期更新,因此公开文档的变更可能需要一段时间才会反映在搜索结果中。

本页面镜像自官方文档:英语 | 日语。注册表: 官方 MCP 注册表上的 com.soracom/knowledge。

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。