Skip to main content
Glama

Soracom Knowledge

by com.soracom

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

TableJSON 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. - 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.

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already indicate readOnlyHint=true and destructiveHint=false, so the read-only nature is clear. The description adds the scope of documents (blogs, changelogs, etc.) but does not disclose any additional behavioral traits like rate limits, result behavior, or authentication requirements. Given the annotations, this is adequate but minimal.

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

Conciseness5/5

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

The description is only five sentences and is front-loaded with the core purpose. Every sentence adds value: purpose, coverage, sibling distinction. No redundant or filler content. Structure is optimal for quick scanning.

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?

The description adequately explains the tool's scope and usage for a search tool with 6 parameters. However, it lacks details about return format, error handling, or result ranking. Given that there is no output schema, omitting return value information is a minor gap. Still, it is complete enough for the tool's relative simplicity.

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

Parameters4/5

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

Schema coverage is 100%, so each parameter has a description in the input schema. The description goes beyond the schema for the 'document_names' parameter by providing detailed explanations of each document's content and language, which helps the agent select appropriate values. This adds significant value beyond the bare schema.

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?

The description clearly states the verb 'Search' and specifies the resource: 'SORACOM service documentation, guides, and console how-to articles'. It also explicitly distinguishes from sibling tool 'search_api_docs' by directing API-related queries there, ensuring agents select the correct tool.

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

Usage Guidelines4/5

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

The description provides clear context on when to use this tool (searching user-facing docs) and when to use the sibling tool 'search_api_docs' (for API references, CLI commands, SAM permissions). However, it does not explicitly state when not to use this tool or mention any prerequisites.

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
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.3/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: get_document fetches full pages, search_api_docs focuses on API/CLI/SAM, and search_soracom_docs covers service guides and console how-tos. No overlap in functionality.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern with underscores (get_document, search_api_docs, search_soracom_docs). The naming is predictable and clear.

Tool Count4/5

Three tools is slightly on the lower side but appropriate for a focused knowledge retrieval server. Each tool serves a necessary role, and the number feels well-scoped.

Completeness4/5

The tool set covers most retrieval needs: searching two distinct document types and fetching full pages. Minor gaps like listing all documents or browsing categories are absent, but the core workflow is complete.

Resources