Skip to main content
Glama

life.ayushrai.site docs MCP

read_doc

Read-only

Find documentation pages that match a query.

Input Schema

NameRequiredDescriptionDefault
queryYesDocumentation topic.

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?

The readOnlyHint annotation already establishes this as a safe read, so the description adds essentially nothing: no result format, no ranking or pagination behavior, no indication whether full page contents or just links are returned. For a search tool these are the traits an agent needs to plan the next call.

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?

One short, front-loaded sentence with no wasted words. It is appropriately sized, though it is so terse that brevity shades into under-specification rather than crispness.

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

Completeness3/5

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

The schema and readOnly annotation cover the mechanical call, but the description leaves unresolved whether this is a search over docs or a page fetch, which is exactly the ambiguity that would misroute an agent against list_docs. Minimal but not complete.

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?

There is a single parameter with 100% schema description coverage ('Documentation topic.'), so the schema carries the semantics. The description repeats the notion of a query without adding syntax, operators, or examples. Baseline 3 applies.

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

Purpose3/5

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

The verb 'Find' with the resource 'documentation pages' gives a workable purpose, but the tool name 'read_doc' implies reading a specific page while the description describes a query-based search. That name/behavior gap means an agent cannot immediately tell whether this retrieves content or a list of matches, and the sibling list_docs is never distinguished.

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?

No guidance on when to use this versus list_docs, no prerequisites, and no statement of what a 'match' means (full text, title, fuzzy). The agent must infer usage entirely from the name.

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.