Skip to main content
Glama

Soracom Knowledge

by com.soracom

search_api_docs

Read-only

Search SORACOM API documentation, CLI references, and SAM permissions. Use for exact API endpoints, soracom-cli commands, or SAM permission strings. Use search_soracom_docs for service guides, console how-tos, pricing, or IoT recipes. Use get_document on #/schema/<Name> links in results to read full API schema fields.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagNoOptional OpenAPI tag such as 'Sim', 'DataEntry', 'Stats', or 'Query'. Exact, case-insensitive; discover valid tags from result api_tag fields.
pathNoOptional API path fragment, matched as a case-insensitive substring excluding the version prefix — e.g. '/sims' or 'subscribers', not '/v1/sims'.
queryNoNatural-language query or API endpoint name. Optional when tag, method, or path is supplied; omit to browse filtered operations.
methodNoOptional HTTP method to narrow results (e.g. 'GET', 'POST'). Exact, case-insensitive match.
languageNoDocumentation language. Omit to auto-detect; set only to pin one language.
max_resultsNoMaximum results to return (1-32). Increase when exploring.
search_modeNoSearch strategy: 'hybrid' combines keyword and vector search; 'keyword' matches exact API paths, operationIds, and parameter names; 'semantic' uses vector similarity only.hybrid

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already indicate readOnlyHint=true and destructiveHint=false. The description adds context about search types and result usage, but no additional traits like rate limits or authorization.

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?

Four well-structured sentences: purpose first, then usage guidance, then cross-reference. No unnecessary words.

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

Completeness5/5

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

For a search tool with 7 parameters, all schema-described, and no output schema, the description effectively explains scope, usage, and integration with sibling tools. It is complete.

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?

All 7 parameters have descriptions in the schema (100% coverage). The description adds extra context, such as 'discover valid tags from result api_tag fields' and 'omit query to browse filtered operations', going beyond 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 it searches SORACOM API documentation, CLI references, and SAM permissions. It distinguishes from sibling tools by specifying when to use each alternative.

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?

Explicitly provides when to use this tool versus siblings: 'Use search_soracom_docs for service guides... Use get_document on ... links in results to read full API schema fields.' Gives clear context.

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