Skip to main content
Glama

Coverage Cat

Coverage Cat docs search

docs_search
Read-onlyIdempotent

Search quickstart, auth, sandbox, OpenAPI, and runtime skill docs on this consumer MCP connection. Topics are ranked by how many query words appear in their title, summary, URI, or category; each match carries its title, category, URI, MIME type, summary, and public href, and an empty matches list means no topic contains any query word. Pass a match's uri to docs_get_resource to read it.

Input Schema

NameRequiredDescriptionDefault
limitNoHow many of the best-ranked topics to return. Omit it to get the top 5.
queryYesSearch terms describing the documentation need.

Output Schema

NameRequiredDescriptionDefault
queryYesThe search query after trimming whitespace.
totalYesNumber of matches in this response after limit, not every topic that matched.
matchesYesMatching topics, best match first.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changed
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of matching documentation topics to return."New value: +"How many of the best-ranked topics to return. Omit it to get the top 5."
    • addedOutput schema / properties / matches / description
      Added value: +"Matching topics, best match first."
    • addedOutput schema / properties / matches / items / properties / category / description
      Added value: +"Docs category: `developers`, `api`, or `skills`."
    • addedOutput schema / properties / matches / items / properties / href / description
      Added value: +"Public web URL for the same content."
    • addedOutput schema / properties / matches / items / properties / mime_type / description
      Added value: +"Format of the resource body, such as `text/markdown` or `text/yaml`."
    • addedOutput schema / properties / matches / items / properties / summary / description
      Added value: +"What the topic covers."
    • addedOutput schema / properties / matches / items / properties / title / description
      Added value: +"Human-readable topic title."
    • addedOutput schema / properties / matches / items / properties / uri / description
      Added value: +"Resource URI to pass to docs_get_resource."
    • addedOutput schema / properties / query / description
      Added value: +"The search query after trimming whitespace."
    • addedOutput schema / properties / total / description
      Added value: +"Number of matches in this response after limit, not every topic that matched."
  2. Changed3 schema fields changed
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of matching documentation topics to return."
    • changedInput schema / properties / query / description
      Previous value: -"Search terms for the documentation need."New value: +"Search terms describing the documentation need."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "matches": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "category": {
      +            "type": "string"
      +          },
      +          "href": {
      +            "type": "string"
      +          },
      +          "mime_type": {
      +            "type": "string"
      +          },
      +          "summary": {
      +            "type": "string"
      +          },
      +          "title": {
      +            "type": "string"
      +          },
      +          "uri": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "title",
      +          "uri",
      +          "mime_type",
      +          "summary",
      +          "category",
      +          "href"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "query": {
      +      "type": "string"
      +    },
      +    "total": {
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "query",
      +    "total",
      +    "matches"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds genuine behavioral detail beyond them: the ranking rule (word overlap in title, summary, URI, category), the fields carried in each match, and the meaning of an empty matches list. No rate limits or pagination are mentioned, but for a read-only search this is solid.

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?

Two sentences, purpose front-loaded, no filler. The middle sentence is dense with ranking and match-field information but each clause earns its place.

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?

An output schema exists, so return values need not be re-explained, yet the description still summarizes match fields and the empty-result case. Combined with the explicit handoff to docs_get_resource and the read-only annotations, an agent has everything needed to call this correctly.

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 both parameters are documented in the schema and the baseline is 3. The description goes beyond that by explaining how the query string is actually consumed (word matching against title, summary, URI, category), which adds semantic value about query construction and result ordering.

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 (docs), enumerates the doc types covered (quickstart, auth, sandbox, OpenAPI, runtime skill docs) and scopes it to 'this consumer MCP connection'. This is enough to distinguish it from docs_list_topics and docs_get_resource 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 Guidelines4/5

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

Gives an explicit follow-up path: 'Pass a match's uri to docs_get_resource to read it', which routes the agent to the correct sibling for retrieval. It stops short of stating when not to use this tool (e.g. versus docs_list_topics for enumeration), so it is clear context without exclusions.

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