Skip to main content
Glama

read_org_doc

Open one document and read it. Returns a shareable console link alongside the body so you can cite what you used. A path you cannot read returns not-found — identical to a path that does not exist, so this never reveals that a file you are denied exists.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nodeNothe document's id, as returned beside its location — survives a rename or a move, so a citation written into a stored document keeps pointing at the right thing. Give this OR location, never both.
shareNothe share id, when this location was shared with you from another workspace — list_org_folders prints it. Omit for your own folders.
tokenNoBearer token identifying the principal. Usually omitted — supplied by the transport (HTTP Authorization header or the server's AGENTLEFS_TOKEN env). Only pass this to override.
offsetNobyte offset to start at (page large files)
locationNofull path from the workspace root, e.g. "handbook/vendor/acme.md". Give this OR node. A path is what a person reads; a node is what survives somebody reorganizing.
maxBytesNomax bytes to return (clamped to MAX_READ_BYTES)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations provided, the description carries the full behavioral burden and does well by disclosing two meaningful behaviors: it returns a shareable console link alongside the body, and it returns not-found for denied paths to avoid revealing file existence. It does not mention pagination or error semantics beyond that, but the core transparency is strong.

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 three sentences with no wasted words. It leads with the action, then the return value, then an important privacy behavior, all in a compact and readable structure.

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 there is no output schema, the description explains the core return value: a shareable console link and the document body. It also covers the privacy-sensitive not-found behavior. It does not describe how offset/maxBytes affect output, but the schema explains those parameters, so the description is largely complete for an agent to invoke the tool correctly.

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 the parameters are already well-documented. The description adds little beyond the schema, except context about path vs. node semantics and the not-found behavior, but it does not need to compensate since the schema covers all six 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 uses a specific verb and resource: 'Open one document and read it.' It clearly signals a single-document read operation, distinguishing it from list, search, write, and edit siblings by focusing on retrieval of an existing document's body and a console link.

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 clearly implies this tool is for reading one document, which is a clear usage context. It does not explicitly name alternatives or when not to use it, but the read-specific language and mention of node/location paths make the intended use evident.

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.

Resources