Skip to main content
Glama

Search SuperCatch documentation

search_docs
Read-onlyIdempotent

Read the public table of contents or find cited documentation summaries with content versions and review dates.

Input Schema

NameRequiredDescriptionDefault
limitNo
queryNoSearch words; omit for the table of contents.
documentIdNoDocument id from the table of contents.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is fully covered. The description contributes that results are 'public' and carry content versions and review dates, which is useful since there is no output schema, but it stops short of describing result shape, ranking, or pagination beyond the limit parameter.

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?

One efficient sentence with no filler, and the primary mode (table of contents) is front-loaded. The trailing clause 'with content versions and review dates' is somewhat ambiguous in what it modifies, which keeps it from a 5.

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

Completeness3/5

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

For a 3-parameter, all-optional search tool with rich annotations this is close to adequate, but with no output schema the description should say more about what a result contains, and it leaves the limit parameter and documentId workflow unaddressed.

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 coverage is 67%: query and documentId are already documented in the schema, including the key behavior of omitting query for the TOC. The description adds no meaning for limit (the one undocumented parameter) and does not explain how documentId is obtained beyond the schema's own note.

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

Purpose4/5

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

The description names a specific verb pair and resource: reading the public table of contents or finding documentation summaries. The word 'public' and 'documentation' distinguish it from siblings like search_account_docs and get_help_resource, though the dual-mode phrasing ('Read ... or find ...') is slightly compressed.

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

Usage Guidelines3/5

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

The two modes imply when each path applies (TOC browsing vs. searched summaries), and the schema reinforces this with 'omit for the table of contents.' However, the description never explicitly states when to prefer this tool over search_account_docs or get_help_resource, leaving sibling selection to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources