Skip to main content
Glama

search_docs

Read-onlyIdempotent

Search the example API documentation to find endpoints, filters, resource fields, error and pagination behavior, returning cited excerpts you can reference. Use it for how-it-works questions, not live data.

Instructions

Search the example API's documentation (the files in knowledge/).

    Use it for how-it-works questions: which endpoints and filters exist, what fields a resource
    has, how errors, pagination or writes behave. Include exact names when known (e.g. /todos,
    userId). Returns a few excerpts, each starting with a citation [source — file]; cite them.
    This is documentation, not live data: use the other tools for actual users, todos or posts.
    

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_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds the return shape — "a few excerpts, each starting with a citation [source — file]; cite them" — which matters because there is no output schema. It does not mention result limits, ranking behavior, or what happens with zero matches, so it falls short of a full behavioral picture. Still a meaningful addition over the annotations.

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 short sentences, front-loaded with what it searches, then when to use, what comes back, and what it is not. Every sentence carries distinct information — no restatement of the name or title.

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

Completeness4/5

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

For a single-param search tool with no output schema, the definition covers corpus, intent, query shapes, and return format (excerpts plus citations). The remaining gap is edge-case behavior — empty results and result-count limits — which an agent would plausibly want.

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?

One required param at 0% schema coverage, so the description carries the burden; it does by naming the query style and giving concrete examples ("/todos, userId"). It does not specify whether the query is keyword, phrase, or natural-language, which slightly limits query construction.

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+resource ("Search the example API's documentation") and pins the corpus ("the files in knowledge/"), which no sibling covers — siblings like list_users and search_posts operate on live data. The opening sentence alone lets an agent distinguish this from every sibling.

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 scopes usage to "how-it-works questions" and enumerates the categories (endpoints, filters, fields, errors, pagination, writes), then states the exclusion outright: "This is documentation, not live data: use the other tools for actual users, todos or posts." It also gives positive query-shaping advice ("Include exact names when known").

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

Deploy Server

Other Tools