Skip to main content
Glama

search_documentation

Read-only

Search Telerivet documentation: User Guide help articles, legal/policy pages, developer API documentation (integrations, OAuth, MCP, Rules Engine, Webhook/REST/Cloud Script APIs — the per-method API reference is NOT here; use get_method_schema for that), and marketing/company content on www.telerivet.com. Use for procedural, troubleshooting, feature, policy, developer, and company questions. Returns matching documents with title, URL, source type, a highlighted snippet, and an id for get_documentation, plus total and has_more — if has_more is true and no clearly relevant result appears, refine the query, narrow with the source filter, or raise per_page (max 25).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "search_documentation"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYesFree-text search query
sourceNoOptional source filter ('web_app' is the web app page/URL catalog, also searchable via get_web_app_urls). Omit to search everything.
per_pageNoMax number of results to return (1-25, default 10)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false, destructiveHint=false, so the safety profile is known; the description goes further by disclosing the exact return payload (title, URL, source type, highlighted snippet, id for get_documentation, total, has_more) and the pagination ceiling of 25. Since there is no output schema, this return-shape disclosure is the only place an agent learns what comes back and how to detect truncation.

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 resource and scope, then the usage trigger, then the return contract and recovery steps — a sensible reading order with no filler sentences. The nested parenthetical listing API subtopics is dense and slightly interrupts flow, keeping it just short of a 5.

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 three-parameter search tool with no output schema, the description covers scope, exclusions, return fields, pagination limits, and refinement strategy — everything needed to call it correctly and interpret a thin result set. Nothing material is missing.

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 adds operational meaning beyond the field text: it frames source as a narrowing mechanism for weak result sets and pairs per_page with the has_more signal so the agent knows raising it is the escalation lever. That is real strategy guidance rather than a restatement of the enum.

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 (Search) and resource (Telerivet documentation), then enumerates the covered corpora and explicitly carves out the per-method API reference, naming get_method_schema as the alternative. An agent can distinguish it from get_documentation and get_method_schema without opening any schema.

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 framing ('procedural, troubleshooting, feature, policy, developer, and company questions'), an explicit exclusion ('per-method API reference is NOT here; use get_method_schema'), and a concrete fallback path when results are weak (refine query, narrow by source, raise per_page).

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