Skip to main content
Glama

read_doc

Read-only

Retrieve the full text of a personal note by its exact name, with an optional character limit, so agents can read note contents after finding them via list_docs or search_docs.

Instructions

Return the full text of one of the user's notes.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "read_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesDocument name exactly as returned by list_docs or search_docs.
max_charsNoMaximum characters to return.

Output Schema

NameRequiredDescriptionDefault
nameYes
textYes
truncatedYes
total_charsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds that the return is the full text of a single note, but it does not disclose truncation via max_chars, the default 20,000-character cap, or any behavior when the note is larger than the limit, which matters for this tool.

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?

A single front-loaded sentence with no wasted words. It is appropriately sized, though it leaves room for one clause about truncation or the sibling distinction without becoming bloated.

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?

An output schema exists, so the description need not explain return values, and the parameters are fully covered by the schema. However, for a read tool with obvious sibling alternatives, the absence of routing guidance leaves a meaningful gap relative to the surrounding toolset.

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%, so both parameters are already documented in the schema, including the exact-name requirement and the max_chars bounds. The description adds no meaning beyond that, so the baseline 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 gives a specific verb and resource ("Return the full text" of "one of the user's notes"), so the agent knows this is a single-document full-text read. It does not distinguish itself from the list_docs, search_docs, or fetch_page siblings, 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 Guidelines2/5

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

There is no explicit when-to-use guidance and no named alternative. The phrase "one of the user's notes" weakly implies reading a known document rather than searching, but the agent must infer that list_docs/search_docs are the discovery path and that fetch_page is unrelated.

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

Deploy Server

Other Tools