Skip to main content
Glama

Read one doc (any kind, the company brief included) with its current `version` and `last_edited` (who saved it, when).

get_doc
Read-onlyIdempotent

Read one doc (any kind, the company brief included) with its current version and last_edited (who saved it, when).

Returns the doc (frontmatter, the markdown body), its current version and last_edited (who saved this version — by, name, agent_token_id — at, and rules: true for the admin-only briefs) — works for every kind, the company brief included. Call this before update_doc, delete_doc, restore_doc_version or acknowledge_handoff and pass the version it returns. at (a commit from get_doc_history) reads an older version.

Input Schema

NameRequiredDescriptionDefault
atNoCommit hash (from get_doc_history) to read an older version.
kindYesProject docs (spec D76): `brief` = why the project exists, goals, business and tech structure; `notes` = working notes / progress; `handoffs` = hand-over to teams or the whole project; `company_brief` = the company's rules and guidelines (read-only in project routes).
slugYesFile name of a doc without `.md`: lowercase a–z 0–9 and `-` (brief, notes, company brief) or `H-{n}` (handoffs).
project_keyYesProject key, e.g. `KJ`. 2–10 chars, uppercase letters and digits, starts with a letter.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already cover readOnly/idempotent/non-destructive, so the description rightly focuses on what they cannot say: the exact returned payload (frontmatter, body, version, last_edited), the `rules: true` flag on admin-only briefs, and the version-pinning contract that makes the subsequent write safe. It does not discuss failure modes (missing slug, access to company brief).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded and short overall, but the opening sentence duplicates the title word-for-word and the '(any kind, the company brief included)' / 'works for every kind' scope claim appears three times. Roughly a third of the text is repetition rather than new information.

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?

With no output schema, the description properly enumerates the returned fields and their meaning, and the pre-mutation version-passing workflow is explained. What remains unaddressed is error/permission behavior for the admin-only brief, which matters for a tool that reads restricted content.

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% with rich per-field descriptions (enum meanings, slug regex, project key format), so the schema does the heavy lifting. The description adds only that `at` takes a commit from get_doc_history — which the schema already states — leaving baseline 3 appropriate.

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 and resource ('Read one doc') with an explicit scope qualifier — any kind, company brief included — and implicitly contrasts with get_doc_history (older versions) and the mutation tools it must precede. An agent can tell it is the single-document read rather than a listing or context bundle.

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?

'Call this before update_doc, delete_doc, restore_doc_version or acknowledge_handoff and pass the `version` it returns' is concrete prescriptive guidance, and the `at` note routes historical reads to get_doc_history. Missing only a negative exclusion (e.g. use list_docs to enumerate, get_docs_context for bulk context).

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