Skip to main content
Glama

get_document

Read-only

Reads ONE document in full: its text as Markdown (derived from the ProseMirror tree — not the editor's raw JSON), its declared language, the block it is attached to, its VERSION (the value update_document expects to modify its content — see below), and — if it is one — the metadata of its file attachment (file name, type, size, upload date; not the binary content itself, to be downloaded from the interface). comments counts the discussion threads anchored to this document (open / total): the Markdown text carries NO trace of them — comment marks are removed on purpose. A non-zero count means there is a discussion to read, and list_comments({documentId}) lists it. Field ABSENT = the question could not be asked, which does not mean "no comments". The text is CANONICAL rewritable Markdown: sending it back as is to contentMarkdown gives back the same document for everything the editor represents (backslash escapes, not HTML entities; a literal angle bracket outside code is written \<x>). warnings (ABSENT when nothing is simplified) names what the format does not carry: omitted underline, flattened table cell (list, multiple paragraphs, code block), merged cells, nesting beyond 100 levels not rendered. The response carries url: the DIRECT LINK of the document (opens the project on this document), which the human follows with one click, unlike the title.

Input Schema

NameRequiredDescriptionDefault
documentIdYesDocument identifier, obtained via list_documents.
expectedProjectIdNoUUID of the project targeted by THIS call. ACTUALLY targets this project instead of the session project. Refused without changing anything if access is not granted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / documentId / description
      Previous value: -"Identifiant du document, obtenu via list_documents."New value: +"Document identifier, obtained via list_documents."
    • changedInput schema / properties / expectedProjectId / description
      Previous value: -"UUID du projet visé par CET appel. Cible RÉELLEMENT ce projet au lieu du projet de session. Refusé sans rien modifier si l'accès n'est pas accordé."New value: +"UUID of the project targeted by THIS call. ACTUALLY targets this project instead of the session project. Refused without changing anything if access is not granted."
  2. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only declare readOnlyHint/openWorldHint; the description goes far beyond by disclosing that comment marks are deliberately stripped, that absent fields mean "could not be asked" rather than "none", that `warnings` names lossy format conversions, and that the text is canonical round-trippable Markdown with specific escaping rules. This is exactly the behavioral context annotations cannot carry.

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?

Front-loaded with the core purpose, then layers the nuances in descending importance. It is dense and occasionally rambling (the version aside, the parenthetical escaping example), but nearly every clause carries information an agent would otherwise get wrong.

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?

No output schema exists, so the description carries the full burden of describing return values — and it does, field by field, including the purpose of `url` versus `title` and the meaning of missing fields. Nothing material needed to call or interpret the result 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 coverage is 100% and both parameters are fully documented there, so the baseline is 3. The description references documentId only incidentally via list_comments({documentId}) and never mentions expectedProjectId or its cross-project targeting/refusal semantics, adding nothing beyond the schema.

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?

Opens with a specific verb+resource and scope ("Reads ONE document in full") and then enumerates exactly what is returned: Markdown text, language, anchor block, version, attachment metadata, and comment counts. An agent can distinguish it from get_document_revision, list_documents, and update_document without opening any schema.

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?

Gives concrete routing: non-zero `comments` means use list_comments({documentId}); the version field is flagged as the value update_document expects. It lacks explicit guidance on when to prefer get_document_revision or list_documents over this tool, but the positive usage contexts are clear.

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.