Skip to main content
Glama
Sign In

SuperCatch

by com.supercatch
OverviewDiscussionsAdmin

Search SuperCatch documentation

supercatch_search_public_docs
Read-onlyIdempotent

Browse or search only publicly readable SuperCatch documentation. Use for public how-to questions: omit query for the table of contents, or select documentId to restrict the document. Account-restricted and staff guides are excluded; API discovery links and help-page navigation are separate resources. Returns documents and cited passages with URLs, versions and review dates; query plus documentId searches only that document. Public; no sign-in required. Read-only; no account connection or content edits. Unknown/invisible documents and unmatched words return empty results; invalid query parameters return a tool error.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "limit": 3,
      "query": "shipping"
    },
    "name": "supercatch_search_public_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum documentation results to return (1-20); defaults to 10.
queryNoPlain-text search words; omit for the table of contents, or combine with documentId to search within one document.
documentIdNoExact document id from the table of contents; omit to search all visible documents. With no query, returns that document.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), and the description goes further by disclosing auth ('Public; no sign-in required'), the return payload shape (documents and cited passages with URLs, versions, review dates), and failure semantics (unknown/invisible documents and unmatched words yield empty results, invalid parameters yield a tool error). That distinction between empty result and error is genuinely useful behavior an agent cannot get from the annotations. It stops short of five only because pagination/ordering behavior for results is not addressed.

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?

Front-loaded with purpose and scope in the first sentence, then modes, exclusions, return shape, and error behavior in a logical order with no filler. It is somewhat dense and run-on as a single block of long sentences, which slightly hurts scannability for a tool with only three optional parameters.

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?

With no output schema, the description compensates by describing what comes back (documents plus cited passages with URLs, versions, review dates). Combined with auth status, exclusions, and error behavior, an agent has everything needed to call this correctly for a simple read-only search tool.

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 the baseline is 3, but the description reinforces the non-obvious interaction of parameters — 'query plus documentId searches only that document' — which is the one combination an agent could get wrong. Edge-case meaning (invisible documents behave as empty rather than error) adds further value beyond the schema text.

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 and resource plus a hard scope restriction ('Browse or search only publicly readable SuperCatch documentation'), which directly separates it from the sibling supercatch_search_account_docs. It also names the neighboring resources it is not ('API discovery links and help-page navigation are separate resources'), so the agent can route without opening schemas.

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?

Gives an explicit use case ('public how-to questions') and the two modes of invocation: omit query for the table of contents, or supply documentId to restrict. It also states exclusions — account-restricted and staff guides are out of scope — leaving nothing to inference about when to pick this over sibling tools.

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

All SuperCatch 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