Skip to main content
Glama
Sign In

Soracom Knowledge

by com.soracom
OverviewDiscussionsAdmin

search_soracom_docs

Read-only

Search SORACOM service documentation, guides, and console how-to articles (user site, service overviews and pricing, IoT recipes). Covers SORACOM services, subscription plans, User Console operations, changelogs, blogs, devices, IoT Store, partners, contract terms, and use cases. Use search_api_docs for API references, CLI commands, or SAM permissions.

Input Schema

NameRequiredDescriptionDefault
queryYesSearch query in natural language related to SORACOM services or console usage
marketNoEnd-user's deployment market, not the query language. Omit if unknown.
languageNoDocumentation language. Omit to auto-detect; set only to pin one language. This does not imply the user's market — use market for that.
max_resultsNoMaximum results to return (1-32). Increase when exploring.
search_modeNoSearch strategy: 'hybrid' combines keyword and vector search; 'keyword' matches exact tokens; 'semantic' uses vector similarity only.hybrid
document_namesNoOptional document-name scope filter. Omit when unsure; narrowing too early can hide relevant results. Each document has a fixed language; only in-scope languages are searched. Available documents: - blog.soracom.com (Japanese): Official blog: announcements, tutorials, event reports, and customer stories. - changelog.soracom.io (English): New feature releases, end-of-service notices, and pricing/spec changes. - changelog.soracom.io/ja (Japanese): New feature releases, end-of-service notices, and pricing/spec changes. - developers.soracom.io (English): SORACOM Developer Site docs. - docs.soracom.io (English): SORACOM Documentation: services, devices, guides, and developer resources. - iot-template-gallery.soracom.io (English): Ready-to-use IoT solution template setup guides. - iot-template-gallery.soracom.jp (Japanese): Ready-to-use IoT solution template setup guides. - iot-usecase.com (Japanese): IoT use cases showing SORACOM across industries. - soracom.io (English): Official blog: announcements, tutorials, event reports, and customer stories. - soracom.io/terms (English): Contract terms and conditions for SORACOM services in English, by region. - soracom.jp/iot-recipes (Japanese): Step-by-step IoT solution recipes with SORACOM. - soracom.jp/iot_basics (Japanese): Introductory IoT fundamentals and related technologies. - soracom.jp/partners (Japanese): SORACOM Partner Space and certified partner information. - soracom.jp/services (Japanese): SORACOM service overviews and pricing. - soracom.jp/store (Japanese): SORACOM IoT Store devices and starter kits. - soracom.jp/support_partners/certified_device (Japanese): SORACOM certified and compatible IoT device catalog. - soracom.jp/terms (Japanese): Contract terms and conditions (利用規約) for SORACOM services in Japanese. - support.soracom.io/hc/en-us (English): SORACOM support FAQs. - support.soracom.io/hc/ja (Japanese): SORACOM support FAQs. - users.soracom.io (Japanese): SORACOM User Site docs for service usage and configuration.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / document_names / description
      Previous value: -"Optional document-name scope filter. Omit when unsure; narrowing too early can hide relevant results. Each document has a fixed language; only in-scope languages are searched. Available documents:\n- blog.soracom.com (Japanese): Official blog: announcements, tutorials, event reports, and customer stories.\n- changelog.soracom.io (English): New feature releases, end-of-service notices, and pricing/spec changes.\n- changelog.soracom.io/ja (Japanese): New feature releases, end-of-service notices, and pricing/spec changes.\n- developers.soracom.io (English): SORACOM Developer Site docs.\n- iot-template-gallery.soracom.io (English): Ready-to-use IoT solution template setup guides.\n- iot-template-gallery.soracom.jp (Japanese): Ready-to-use IoT solution template setup guides.\n- iot-usecase.com (Japanese): IoT use cases showing SORACOM across industries.\n- soracom.io (English): Official blog: announcements, tutorials, event reports, and customer stories.\n- soracom.io/terms (English): Contract terms and conditions for SORACOM services in English, by region.\n- soracom.jp/iot-recipes (Japanese): Step-by-step IoT solution recipes with SORACOM.\n- soracom.jp/iot_basics (Japanese): Introductory IoT fundamentals and related technologies.\n- soracom.jp/partners (Japanese): SORACOM Partner Space and certified partner information.\n- soracom.jp/services (Japanese): SORACOM service overviews and pricing.\n- soracom.jp/store (Japanese): SORACOM IoT Store devices and starter kits.\n- soracom.jp/support_partners/certified_device (Japanese): SORACOM certified and compatible IoT device catalog.\n- soracom.jp/terms (Japanese): Contract terms and conditions (利用規約) for SORACOM services in Japanese.\n- support.soracom.io/hc/en-us (English): SORACOM support FAQs.\n- support.soracom.io/hc/ja (Japanese): SORACOM support FAQs.\n- users.soracom.io (Japanese): SORACOM User Site docs for service usage and configuration."New value: +"Optional document-name scope filter. Omit when unsure; narrowing too early can hide relevant results. Each document has a fixed language; only in-scope languages are searched. Available documents:\n- blog.soracom.com (Japanese): Official blog: announcements, tutorials, event reports, and customer stories.\n- changelog.soracom.io (English): New feature releases, end-of-service notices, and pricing/spec changes.\n- changelog.soracom.io/ja (Japanese): New feature releases, end-of-service notices, and pricing/spec changes.\n- developers.soracom.io (English): SORACOM Developer Site docs.\n- docs.soracom.io (English): SORACOM Documentation: services, devices, guides, and developer resources.\n- iot-template-gallery.soracom.io (English): Ready-to-use IoT solution template setup guides.\n- iot-template-gallery.soracom.jp (Japanese): Ready-to-use IoT solution template setup guides.\n- iot-usecase.com (Japanese): IoT use cases showing SORACOM across industries.\n- soracom.io (English): Official blog: announcements, tutorials, event reports, and customer stories.\n- soracom.io/terms (English): Contract terms and conditions for SORACOM services in English, by region.\n- soracom.jp/iot-recipes (Japanese): Step-by-step IoT solution recipes with SORACOM.\n- soracom.jp/iot_basics (Japanese): Introductory IoT fundamentals and related technologies.\n- soracom.jp/partners (Japanese): SORACOM Partner Space and certified partner information.\n- soracom.jp/services (Japanese): SORACOM service overviews and pricing.\n- soracom.jp/store (Japanese): SORACOM IoT Store devices and starter kits.\n- soracom.jp/support_partners/certified_device (Japanese): SORACOM certified and compatible IoT device catalog.\n- soracom.jp/terms (Japanese): Contract terms and conditions (利用規約) for SORACOM services in Japanese.\n- support.soracom.io/hc/en-us (English): SORACOM support FAQs.\n- support.soracom.io/hc/ja (Japanese): SORACOM support FAQs.\n- users.soracom.io (Japanese): SORACOM User Site docs for service usage and configuration."
    • changedInput schema / properties / document_names / items / enum
      Previous value: -[
-  "blog.soracom.com",
-  "changelog.soracom.io",
-  "changelog.soracom.io/ja",
-  "developers.soracom.io",
-  "iot-template-gallery.soracom.io",
-  "iot-template-gallery.soracom.jp",
-  "iot-usecase.com",
-  "soracom.io",
-  "soracom.io/terms",
-  "soracom.jp/iot-recipes",
-  "soracom.jp/iot_basics",
-  "soracom.jp/partners",
-  "soracom.jp/services",
-  "soracom.jp/store",
-  "soracom.jp/support_partners/certified_device",
-  "soracom.jp/terms",
-  "support.soracom.io/hc/en-us",
-  "support.soracom.io/hc/ja",
-  "users.soracom.io"
-]New value: +[
+  "blog.soracom.com",
+  "changelog.soracom.io",
+  "changelog.soracom.io/ja",
+  "developers.soracom.io",
+  "docs.soracom.io",
+  "iot-template-gallery.soracom.io",
+  "iot-template-gallery.soracom.jp",
+  "iot-usecase.com",
+  "soracom.io",
+  "soracom.io/terms",
+  "soracom.jp/iot-recipes",
+  "soracom.jp/iot_basics",
+  "soracom.jp/partners",
+  "soracom.jp/services",
+  "soracom.jp/store",
+  "soracom.jp/support_partners/certified_device",
+  "soracom.jp/terms",
+  "support.soracom.io/hc/en-us",
+  "support.soracom.io/hc/ja",
+  "users.soracom.io"
+]
  2. First observed

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the description does not need to restate the safety profile. It adds the useful scoping fact that only SORACOM-owned document sources are searched, but says nothing about result ranking, pagination, or how many/which results come back, so it remains at the minimum-viable level for behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, front-loaded with the resource and scope before the routing rule, with no filler. The middle sentence is a long topical list that partially duplicates the document_names description in the schema, which is the only inefficiency.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 6-parameter read-only search tool with full schema coverage and no output schema, the description supplies the domain scope and the sibling routing rule an agent needs. It stops short of describing what a result looks like or how to widen/narrow effectively, but the parameters (max_results, search_mode, document_names) already carry that.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, including enum meanings and the market-vs-language distinction, so the schema carries the parameter burden. The description's content enumeration broadly maps to the document_names scope filter but adds no syntax, default, or interaction detail beyond what the schema already states, making the baseline 3 correct.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Search) and resource (SORACOM service documentation, guides, console how-to articles) and enumerates the concrete content domains covered (user site, service overviews and pricing, IoT recipes, changelogs, devices, IoT Store, partners, contract terms). It explicitly distinguishes itself from the sibling search_api_docs, so an agent can route without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The final sentence names the alternative tool and the exact conditions that select it: API references, CLI commands, or SAM permissions go to search_api_docs. This is an explicit when-to-use vs. when-to-use-the-other statement, not implied guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Soracom Knowledge toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources