Skip to main content
Glama

Coline

Read a doc

get_doc
Read-onlyIdempotent

Reads a doc's title, text and revision. Pass the revision as baseRevision when rewriting it.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace": "<workspace>",
      "docId": "<docId>"
    },
    "name": "get_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
docIdYesDoc id from search, fetch or create_doc.
workspaceYesWorkspace slug from workspaces.list, e.g. "acme".

Output Schema

NameRequiredDescriptionDefault
urlYes
textYes
docIdYes
titleYes
revisionYes
textTruncatedYes

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description's real addition is the optimistic-concurrency hint about the revision, but it does not say what happens if baseRevision is stale.

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 tight sentences with the read purpose front-loaded and the workflow tip second. Every clause carries information and nothing is padded.

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 a rich output schema, full parameter documentation and comprehensive annotations, the description only needed to add the revision-round-trip guidance, which it does. A note on stale-revision behavior or the sibling to use for listing would make it complete.

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 both docId and workspace documented in the schema, so the baseline is 3. The description adds no meaning about either parameter and only references baseRevision, which is not a parameter of this tool.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Reads a doc') and names the data returned (title, text, revision), which goes beyond the tautological title. It does not distinguish itself from nearby siblings such as show_doc or read_file, so an agent must infer the difference.

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?

The second sentence gives a concrete workflow cue: read the doc and carry its revision forward as baseRevision when rewriting. That implies read-before-write, but no explicit when-not conditions or named alternatives (e.g. show_doc) are given.

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