Skip to main content
Glama

Search documentation available to my account

supercatch_search_account_docs
Read-onlyIdempotent

Search documentation using the connected account's current permissions. Use for account-restricted or staff guidance; omitting query returns the permission-filtered table of contents. Public-only questions do not need account access, and sign-in does not itself grant staff permissions. Returns visible documents and cited passages with versions and review dates; query plus documentId narrows the search to that document. Requires OAuth docs:read consent. Staff guides additionally require current staff permissions. Read-only; access is checked against the current role without modifying documentation. Missing/insufficient consent produces HTTP 401/403; unavailable documents are omitted and invalid queries 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": "store pricing"
    },
    "name": "supercatch_search_account_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.2/5.0
Behavior3/5

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

With readOnlyHint, idempotentHint and destructiveHint already declaring the safety profile, the description adds real value: OAuth docs:read consent, staff-permission gating, 401/403 outcomes, silent omission of unavailable documents, and tool errors for invalid queries. However, it also spends a sentence restating read-only behavior that the annotations already assert, and it does not cover result-size or pagination behavior 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?

Front-loads the core action and scope, then layers use cases, return shape, and error behavior in a logical order with no filler sentences. It is dense to the point of being a single run-on block, which slightly hurts scanability.

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 no-required-parameter search tool with no output schema, the description covers the return contents (documents, cited passages, versions, review dates), auth prerequisites, permission gating, and error modes. An agent has everything needed to call it correctly and interpret a failure.

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 100% and the description's parameter guidance ('omitting query returns the permission-filtered table of contents', 'query plus documentId narrows the search') largely restates what the schema already documents for query and documentId. The only genuinely added meaning is that the table of contents is permission-filtered, which is marginal over 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 the scoping constraint ('using the connected account's current permissions'), and implicitly distinguishes itself from supercatch_search_public_docs by noting that public-only questions don't need account access. An agent can pick between the two doc-search tools from the description alone.

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 explicit when-to-use ('account-restricted or staff guidance'), when-not ('Public-only questions do not need account access'), and a clarifying exclusion that sign-in does not confer staff permissions. The omitted-query table-of-contents case is also spelled out, so no usage decision is left 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