Skip to main content
Glama

Read a document

get_doc
Read-onlyIdempotent

Return a document with its full body. A markdown document returns Markdown, an html document returns the whole HTML page. The kind field says which.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
docYesA document id, or its exact title.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

The description goes beyond the annotations by explaining that the full body is returned and that output format depends on document kind, with a kind field indicating it. The annotations already cover read-only, idempotent, non-destructive behavior, so this added return-format context earns a strong score.

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?

Two sentences deliver the core behavior without filler. The key idea, returning the full body, is front-loaded, and the format clarification is concise and useful.

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?

For a simple single-parameter read tool, the description is complete: it explains what is returned, how format varies, and that a kind field disambiguates. The schema documents the parameter and the annotations cover the safety profile, so nothing essential is missing.

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%, and the param schema already states that the value is a document id or exact title. The tool description adds no additional meaning about the parameter, so the baseline score of 3 applies.

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 states a clear verb and resource: return a document with its full body, and it adds format-specific details. It does not explicitly differentiate itself from sibling tools like list_docs or read_attachment, so it stops short of a 5.

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

Usage Guidelines3/5

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

The read intent is clear and implies when to use it, but there is no explicit guidance about alternatives or when not to use it. An agent is left to infer that this tool is for fetching a single document body rather than listing or searching documents.

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.