Skip to main content
Glama

get_document

Read-only

Read one viewable artifact’s metadata, versions, visible review requests, threads, and optional source without changing state. Source defaults to the latest version unless versionId selects another; includeSource defaults to true. Embedded image bytes are omitted, so use the version resource when complete source is required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
versionIdNoVersion whose source to return; omit to use the latest version.
documentIdYesID of the artifact containing the target resource.
includeSourceNoWhether to include compacted source in the result.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
sourceNo
threadsYes
documentYesArtifact metadata and lifecycle counters.
versionsYes
reviewRequestsYes

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the readOnlyHint annotation, the description discloses important behaviors: the source defaults to the latest version, includeSource defaults to true, and embedded image bytes are omitted unless the version resource is used. It also explains the effect of versionId on source selection, adding substantial behavioral context that annotations alone do not provide.

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, each providing distinct value: purpose, default behavior, and limitation/alternative. It is front-loaded with the main verb and resource, with no redundant or filler content. Every sentence earns its place.

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?

Given that an output schema exists, the description need not explain return values. It covers the key operational details: the set of retrieved data, state-safety, default behaviors, and the critical limitation about image bytes. For a tool with three parameters and a structured output, this is sufficiently complete to guide correct invocation.

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?

The input schema already provides descriptions for all three parameters (100% coverage), so the baseline is 3. The description adds value by explicitly stating defaults for versionId and includeSource ('Source defaults to the latest version unless versionId selects another; includeSource defaults to true') and by noting the consequence of image omission. This goes beyond the schema's simple parameter descriptions, meriting a 4.

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 opens with 'Read one viewable artifact’s metadata, versions, visible review requests, threads, and optional source', which clearly states the verb (Read), the resource (viewable artifact), and the scope (one artifact). It distinguishes itself from list_documents by specifying 'one' and from mutation tools by stating 'without changing state'. The inclusion of specific items (metadata, versions, review requests, threads) further clarifies its purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

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

The description gives explicit usage context: 'Read one viewable artifact...' implies use when needing details of a single artifact, and 'without changing state' explicitly excludes mutation use cases. It also provides an alternative: 'Embedded image bytes are omitted, so use the version resource when complete source is required.' This satisfies the when/when-not/alternatives criterion.

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.

TDQS

A4.5/5.0
Disambiguation5/5

Each tool targets a distinct action: comment creation vs. reply, review request vs. completion, thread status vs. comment, document read vs. list. No two tools have overlapping responsibilities, and descriptions clarify precise usage.

Naming Consistency5/5

All tools follow a consistent verb_noun snake_case pattern (add_comment, complete_review, create_document, get_document, list_documents, list_review_inbox, list_threads, publish_version, reply_to_thread, request_review, set_thread_status). whoami deviates slightly but is a standard, recognizable exception.

Tool Count5/5

12 tools is well within the optimal 3-15 range and appropriately covers the document/review/thread domain without bloat or excessive abstraction. Each tool serves a clear purpose in the workflow.

Completeness4/5

Core lifecycle is covered: document creation/reading/versioning, review request/completion/inbox, and thread create/reply/status. Minor gaps exist, such as no explicit document deletion or metadata update, but these do not hinder primary review workflows.

Resources