Skip to main content
Glama

Project Document Get

project_document_get
Read-onlyIdempotent

Read one exact owned project document revision and its bounded revision history. Omit revision for latest; use explicit revision when recording evidence.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
revisionNo
project_idYes
document_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already establish read-only, idempotent, non-destructive behavior. The description adds only the 'bounded revision history' nuance, which is minor extra transparency beyond the annotations.

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?

Two concise sentences that efficiently communicate purpose and key usage nuance. No redundant or irrelevant content.

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?

The description is sufficient for a simple read operation given the annotations. It does not describe output format, but for a 'get' tool with no output schema provided, this is acceptable and the core behavior is clear.

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?

Schema defines types and formats for all parameters. The description adds meaningful semantics for the optional 'revision' parameter (omit for latest, use for evidence), which is not fully captured in the schema alone.

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 clearly states the tool reads a specific project document revision and its bounded history, distinguishing it from create/revise tools. The distinction between latest and explicit revision adds precision.

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?

Provides guidance on when to omit or include the revision parameter, which serves as usage direction. However, it does not explicitly compare to sibling tools like project_get or project_document_create, so it lacks direct alternative selection 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