Skip to main content
Glama

Read docs

docs_read
Read-onlyIdempotent

Read one of your documents in full, by id or by exact title

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoDocument id, from docs_list
titleNoExact title, if you do not have the id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added
  2. Removed
  3. Added

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the agent knows it's a safe, side-effect-free read. The description adds 'in full' to clarify return scope, but does not disclose potential size limits, pagination, or whether missing parameters cause errors. This is acceptable given the simple read nature.

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?

One sentence, front-loaded with the verb and resource, no filler. It provides exactly the necessary information in a clear, scannable format.

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 simple read tool, the description covers purpose, identification, and safety (via annotations). The main gap is not stating that exactly one of id/title must be provided, given the schema allows both to be absent. Still, overall it is complete enough for a competent agent.

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?

Schema description coverage is 100%: both 'id' and 'title' have clear descriptions. The description echoes 'by id or exact title' but does not clarify that at least one is needed (the schema marks both optional). This ambiguity is a missed opportunity to add value beyond the schema.

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?

The description states a specific verb ('Read') and resource ('your documents') with clear scoping ('in full'), which distinguishes it from docs_list, docs_write, and other document tools. The identification method ('by id or by exact title') adds precision.

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?

The description gives clear context: use this tool to read a full document when you have an id or exact title. It does not explicitly mention alternatives (e.g., docs_list to find an id) or exclusions, but the context is clear enough for an agent with sibling tool names.

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.