Soracom Knowledge MCP server
Commit Oct 8, 2026Lets AI agents search Soracom service guides, API references, IoT recipes, and CLI commands to ground answers in official documentation.
Also known as soracom/mcp, knowledge
- Stars
- 4
- Tools
- 9
- Downloads, 30 days
- —
- Latest version
- 1.1.5
- Last commit
- Oct 8, 2026
- License
- MIT
What is Soracom Knowledge MCP?
Soracom Knowledge lets AI agents search Soracom service guides, API references, IoT recipes, and CLI commands to ground answers in official documentation. It exposes 9 tools, such as query, document_names, search_mode.
Summary generated from the project's README
About Soracom Knowledge MCP server
Grounding AI agents in official Soracom documentation is what this MCP server enables for developers building IoT solutions. By connecting to this remote, read-only endpoint via HTTP transport, clients like Claude Code or OpenAI Codex can access service guides, API references, and IoT recipes. This prevents agents from relying solely on outdated training data by providing real-time access to technical specifications.
The server provides three specific tools: search_soracom_docs for finding service overviews and pricing, search_api_docs for looking up CLI commands, SAM permissions, and API endpoints, and get_document to retrieve the full Markdown content of a specific page. Users can choose between keyword, semantic, or hybrid search modes to refine their results.
Because the server uses semantic search, queries are processed using OpenAI embeddings. The setup is straightforward for remote clients, requiring only the HTTPS endpoint. It is designed for reading public information only and does not have the ability to modify any Soracom account resources or user data.
What you can do with it
- 1Retrieve official API specificationsAsk an AI agent to find the specific HTTP method and path for a Soracom service endpoint.
- 2Consult IoT implementation guidesHave an AI agent search for specific IoT recipes to help implement connectivity solutions.
- 3Extract full documentation contentInstruct an agent to read the complete Markdown text of a specific documentation page found during a search.
- 4Check service pricing and proceduresUse natural language to find information regarding Soracom service costs or User Console steps.
Written from the project's README. Every use case is checked against a quote from it.
How to install Soracom Knowledge MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall Soracom Knowledge MCP in Claude Code
$ claude mcp add --transport http knowledge https://knowledge-mcp.soracom.com/Install Soracom Knowledge MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"knowledge": {
"url": "https://knowledge-mcp.soracom.com/"
}
}
}Install Soracom Knowledge MCP in VS Code
.vscode/mcp.json
{
"servers": {
"knowledge": {
"type": "http",
"url": "https://knowledge-mcp.soracom.com/"
}
}
}Install Soracom Knowledge MCP in VS Code CLI
$ code --add-mcp '{"name":"knowledge","type":"http","url":"https://knowledge-mcp.soracom.com/"}'Install Soracom Knowledge MCP in Codex
$ codex mcp add knowledge --url https://knowledge-mcp.soracom.com/Install Soracom Knowledge MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.knowledge] url = "https://knowledge-mcp.soracom.com/"
Install Soracom Knowledge MCP in Gemini CLI
$ gemini mcp add -s user --transport http knowledge https://knowledge-mcp.soracom.com/Install Soracom Knowledge MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"knowledge": {
"url": "https://knowledge-mcp.soracom.com/",
"type": "http"
}
}
}Soracom Knowledge MCP tools 9
Detected from the READMEquerydocument_namessearch_modelanguagemax_resultstagmethodpathurl
| query | — | |
| document_names | — | |
| search_mode | — | |
| language | — | |
| max_results | — | |
| tag | — | |
| method | — | |
| path | — | |
| url | — |
Automated checks
Ran Nov 14, 2026Full report →Not verified yet. A server needs a score of 80, no serious finding, and enough data for us to check. How checks work · What to fix for more points
- Source repository linked and reachablesoracom/mcp is public and reachablegithub.com/soracom/mcp ↗Pass
- Package names this repository as its sourceNot checked
- Build provenance (Sigstore attestation)Not checked
- Open source license (OSI)MITspdx.org/licenses/MIT.html ↗Pass
- Commit or release in the last yearLast commit or release 2026-10-08github.com/soracom/mcp ↗Pass
- OpenSSF ScorecardNot checked
- Package name not close to a popular packageNot checked
- No critical advisory in the package or its dependenciesNot checked
- No hidden instructions to the model9 tool descriptions and the README read; no override phrases, credential paths or hidden charactersPass
- Destructive tools are labelledNo tool named like delete, drop or execPass
- Remote endpoint answers the MCP handshakeinitialize answered with protocol 2025-06-18 in 574 msPass
README
View on GitHubSoracom Knowledge MCP Server
The Soracom Knowledge MCP Server is an MCP (Model Context Protocol) server that lets AI agents search Soracom documentation and Soracom API references directly from your development environment. When connected to an MCP client such as Claude Code, OpenAI Codex, or Claude Desktop, the agent can look up service guides, Soracom User Console procedures, pricing, IoT recipes, Soracom API references, CLI commands, and SAM permissions on demand, and ground its answers in the official documentation instead of relying only on its training data.
The server is hosted by Soracom as a shared, read-only endpoint. It does not modify any of your Soracom resources—the agent only searches and reads documentation.
Available Tools
The server exposes three read-only tools to the connected agent. None of them modify your account or its resources.
The server's default hybrid search mode combines keyword search with semantic search (using OpenAI embeddings) and merges the results using Reciprocal Rank Fusion (RRF).
search_soracom_docs
Searches Soracom service guides, Soracom User Console procedures, service overviews and pricing, and IoT recipes.
| Parameter | Description |
|---|---|
query |
A natural-language search query (required). |
document_names |
Restricts the search to specific sites (e.g., ["docs.soracom.io", "users.soracom.io"]). The available sites are listed in the tool schema. Omit it to search all sources. |
search_mode |
hybrid (default; combines keyword and semantic search), keyword (keyword search only), or semantic (semantic similarity only). |
language |
English or Japanese. Auto-detected from the query when omitted. |
max_results |
Number of results to return. Default 16, maximum 32. |
search_api_docs
Searches Soracom API references, CLI commands, and SAM permissions.
| Parameter | Description |
|---|---|
query |
A natural-language question or an API endpoint name. Optional when at least one of tag, method, or path is supplied. |
tag |
Restricts results to a service tag (e.g., Sim, Subscriber, Flux). Case-insensitive exact match. |
method |
Restricts results to an HTTP method (e.g., GET, POST). Case-insensitive exact match. |
path |
Restricts results to an API path fragment (e.g., /sims). Case-insensitive substring match. |
search_mode |
hybrid (default; combines keyword and semantic search), keyword (keyword search only), or semantic (semantic similarity only). |
language |
English or Japanese. Auto-detected from query when query is provided. If you omit query, specify language explicitly. |
max_results |
Number of results to return. Default 16, maximum 32. |
get_document
Fetches the full Markdown of a page returned by search_soracom_docs or search_api_docs.
| Parameter | Description |
|---|---|
url |
The URL of the page to fetch (required). Pass the url value from a search result verbatim. A search result may return a URL that is not directly viewable in a browser (such as a fragment of a split API reference), but this tool can still fetch its content. |
Connecting the Server
The server is reachable at a stable public HTTPS endpoint and uses the MCP Streamable HTTP transport:
https://knowledge-mcp.soracom.com
[!WARNING] The server has no per-user authentication. It only searches and returns public Soracom documentation, but any query you enter is sent to the endpoint. With the
hybridorsemanticsearch mode, your query is also sent to OpenAI to generate embeddings. Do not include confidential information, account identifiers, credentials, or personal data in your queries.For Soracom's terms and privacy practices, see the Terms and Conditions and Privacy Policy. Soracom does not record or retain the content of your queries in its server logs. Soracom also does not share OpenAI API inputs or outputs with OpenAI for model improvement, evaluation, fine-tuning, or training. For details, see OpenAI's Business data privacy, security, and compliance.
Use of this server is subject to our Site Policy (available in Japanese), which includes disclaimers, copyright terms, and provides that use is governed by the laws of Japan, with the Tokyo District Court as the exclusive court of first instance. The Japanese text prevails.
Claude Code
Claude Code supports remote HTTP MCP servers natively. Add the server with the claude mcp add command:
claude mcp add --transport http soracom-knowledge https://knowledge-mcp.soracom.com
Verify that the server is connected:
claude mcp list
The soracom-knowledge server and its three tools are now available in your Claude Code sessions. To remove it later, run claude mcp remove soracom-knowledge.
OpenAI Codex
The Codex CLI supports remote MCP servers over HTTP. Add the server with:
codex mcp add soracom-knowledge --url https://knowledge-mcp.soracom.com
List configured servers to confirm:
codex mcp list
Notes and Limitations
- This server is provided free of charge on a best-effort basis and without an SLA. Its specifications may change without notice as the service is improved.
- Access may be temporarily restricted if an excessive number of requests are detected.
- A result set may include pages that are only loosely related to your query. The agent is expected to filter these; treat individual hits as candidates rather than authoritative matches.
- The information returned by this server is provided "AS-IS", and answers generated by an AI agent are not guaranteed to be accurate. Verify important details against the linked source pages.
- The search index is updated periodically, so it may take some time for changes to the public documentation to be reflected in search results.
This page mirrors the official documentation: English | Japanese. Registry: com.soracom/knowledge on the Official MCP Registry.
Soracom Knowledge MCP questions
How do I add Soracom Knowledge MCP to Claude Code?
Run claude mcp add --transport http knowledge https://knowledge-mcp.soracom.com/ in your terminal. Add --scope user to make it available in every project.
How do I add Soracom Knowledge MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What tools does Soracom Knowledge MCP provide?
It exposes 9 tools, including query, document_names, search_mode, language, max_results.
Does this server modify my Soracom account?
No, the server is a read-only endpoint that only searches and reads documentation without modifying any resources.
Is authentication required to use the server?
The server does not require per-user authentication as it only accesses public documentation.
What search modes are available?
You can use hybrid search, which combines keyword and semantic search, or choose between keyword-only or semantic-only modes.