Skip to main content
Glama

Get a document

get_document
Read-only

Use when the user wants to read an existing SharedBrief document or retrieve its latest content and revision before editing. Returns a document owned by the connected account, its actual publication state, and whether its URL is for the owner or readers. Imported originals return bounded file metadata; authenticated embedded preview handles original bytes and HTML source.

Input Schema

NameRequiredDescriptionDefault
idYesUUID of an existing document owned by the connected SharedBrief account, returned by document creation or listing.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / id / description
      Added value: +"UUID of an existing document owned by the connected SharedBrief account, returned by document creation or listing."
  2. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, non-destructive, closed-world), and the description adds meaningfully: it scopes results to documents owned by the connected account, reports actual publication state and whether the URL is owner- or reader-facing, and flags that imported originals return only bounded file metadata while original bytes/HTML come from an authenticated embedded preview. That is substantive behavioral context beyond the structured fields.

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 usage, then return semantics, then the import/preview nuance; each sentence carries information. The final sentence is jargon-dense ("authenticated embedded preview handles original bytes and HTML source") and costs a little readability.

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?

With no output schema, the description takes on the burden of describing returns and does so: ownership scope, publication state, URL audience, and the import/preview distinction. An agent has enough to call it correctly and anticipate the response shape.

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?

Only one parameter and schema_description_coverage is 100%, so the schema already carries the meaning of id. The description adds a light constraint by saying the document must be owned by the connected account, but no additional syntax or sourcing detail beyond what the schema states.

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?

States a specific verb+resource (read/retrieve an existing SharedBrief document and its latest content/revision) and implicitly separates itself from list_documents and update_document by framing retrieval as a read step. An agent can tell this is a single-document fetch rather than a listing or mutation.

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?

"Use when the user wants to read an existing SharedBrief document or retrieve its latest content and revision before editing" gives a clear trigger plus a workflow context (pre-edit refresh). It does not name competing siblings such as read_document_for_app, read_document_file_from_app, or show_document, nor state exclusions, so no explicit when-not guidance.

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