Skip to main content
Glama

read_doc

Retrieve decrypted document content from encrypted markdown storage, optionally previewing lines or returning metadata.

Instructions

Read a document's decrypted content.

Args: doc_id: UUID of the document to read lines: Optional - return only the first N lines (for previews) as_markdown: If True, return plain markdown; if False, return JSON with metadata

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doc_idYes
linesNo
as_markdownNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

Without annotations, the description carries the full burden. It discloses key behavioral traits: decryption occurs during reading, and output format varies (markdown vs JSON with metadata) based on as_markdown flag. However, it omits safety profile (idempotency, read-only nature), error conditions, or authorization requirements.

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 appropriately sized with zero waste. The Args section structure efficiently maps parameters to their semantics. The front-loaded first sentence establishes purpose immediately. Minor deduction for informal docstring formatting ('Args:') which is slightly less readable than prose.

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 presence of an output schema (not shown but indicated in context signals), the description appropriately focuses on input parameters and high-level behavior rather than return values. For a 3-parameter read operation with decryption complexity, the description covers the essential contract adequately.

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

Parameters4/5

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

With 0% schema description coverage (no description fields in the JSON schema), the description effectively compensates by documenting all three parameters: doc_id as 'UUID', lines as 'Optional - return only the first N lines', and as_markdown behavior. This provides essential semantic context missing from the structured schema.

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 clearly states the tool 'Read[s] a document's decrypted content'—specific verb (read), specific resource (document), and unique scope (decrypted content). This distinguishes it from siblings like create_doc or update_doc, though it doesn't explicitly contrast with read_workspace.

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?

The description provides no explicit guidance on when to use this tool versus alternatives (e.g., when to use lines parameter for previews vs full read). The phrase 'for previews' implies a use case for the lines parameter but doesn't constitute explicit when/when-not guidance for the tool itself.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bndkts/molt-md-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server