Skip to main content
Glama

Read an attached document

read_document
Read-onlyIdempotent

Read a document previously attached to a calendar (ids are listed in get_status under documents). Use when revising a plan so the new plan respects the syllabus/history the user provided.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doc_idYes
admin_tokenYes
calendar_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNoA user-safe error message when the document cannot be read.
contentNoThe attached document text.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, covering safety semantics. The description adds useful behavioral context beyond that: it clarifies that the document must have been 'previously attached to a calendar' and shows how to find acceptable doc_id values via get_status. This gives a concrete operational detail not present in annotations.

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?

The description is two sentences, each with a clear purpose: the first states the action and scope, the second provides usage context and a pointer to find document IDs. There is no redundant phrasing or filler. It is front-loaded with the core verb and resource, making it easy to scan.

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?

Given the tool's low complexity and the presence of annotations and an output schema, the description covers the essential context: what the tool reads, where IDs come from, and when to use it. It doesn't explain return values or error handling, but the output schema presumably covers that. The main gap is lack of context for calendar_id and admin_token, but those are inferable from the tool's purpose.

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 coverage is 0%, so the description must compensate for the lack of parameter descriptions. It directly explains doc_id by saying 'ids are listed in get_status under documents,' which is helpful. However, it does not explain calendar_id or admin_token, leaving those parameters somewhat under-specified. The description partially compensates but not fully for all three required parameters.

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 clearly states the tool's function: 'Read a document previously attached to a calendar.' It distinguishes itself from siblings like attach_document, get_status, and revise_calendar by specifying its scope and resource. The reference to get_status for document IDs adds precise context, making it obvious this tool is for retrieving attached documents, not creating or modifying them.

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 provides explicit guidance on when to use the tool: 'Use when revising a plan so the new plan respects the syllabus/history the user provided.' It also points to get_status as the source for document IDs. Although it doesn't explicitly list alternatives or when-not-to-use scenarios, the use case is clear enough to guide an agent's decision-making.

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.

TDQS

A4.3/5.0
Disambiguation5/5

Each tool targets a distinct action: creating, validating, revising, monitoring, attaching/reading documents, sharing, and template exploration. There is no overlap between create_calendar and revise_calendar, or between list_templates and get_template_guide.

Naming Consistency5/5

All tool names follow a consistent lowercase verb_noun pattern with underscores (e.g., create_calendar, get_status, validate_spec). No mixed conventions or vague verbs.

Tool Count5/5

With 9 tools, the set is well-scoped for the calendar lifecycle: setup, planning, monitoring, and support. Each tool earns its place without redundancy.

Completeness5/5

The tool surface covers the full workflow: template discovery, spec validation, calendar creation, revision, status checks, document attachment/reading, and sharing. No obvious missing operations for the intended coaching use case.