Skip to main content
Glama

Agent Surface

Search Docs

search

Search docs pages with a query

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
localeNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.7/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only restates the search action and offers no information about result format, ranking, pagination, limits, or failure behavior. This is a significant transparency gap.

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?

The description is a single sentence with the verb and object front-loaded and no filler words. It is appropriately concise, even though the terseness comes at the cost of behavioral detail.

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

Completeness2/5

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

For a simple two-parameter tool the basic call shape is present, but the lack of annotations, output schema, and usage guidance leaves important gaps: result format, locale behavior, and when to prefer search over siblings are all unspecified. The description is not robust enough for reliable agent decision-making.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description needed to explain the parameters, but it only mentions 'a query' without format or semantics. The optional locale parameter is not addressed at all, leaving the agent to guess its valid values and effect.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('search') and a clear target ('docs pages'), and indicates the operation is query-based. It reasonably differentiates from the siblings get_page and list_pages by implying keyword search rather than retrieval by ID or enumeration, though it does not spell out the distinction.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

There is no guidance about when to use this tool versus get_page or list_pages, no mention of prerequisites, and no exclusions. An agent must infer the appropriate context entirely from the tool name and one-sentence description.

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.