Skip to main content
Glama

某版修订全文

gwl_get_document_revision
Read-onlyIdempotent

Read the full content of a specific document revision and return whether it is the current version and can be restored. Use it to inspect revision details by document ID and revision number.

Instructions

读取某一版修订的全文,并带 current_version 与 can_restore。 该修订不存在 404;没有内容快照 404。

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": {
      "doc_id": "<doc_id>",
      "rev": "<rev>"
    },
    "name": "gwl_get_document_revision"
  }
}

Input Schema

NameRequiredDescriptionDefault
revYes修订号(路径参数)。
doc_idYes文档 id(路径参数)。

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover readOnly, idempotent and non-destructive, so the safety profile is known. The description adds genuinely new behavior: the response carries current_version and can_restore, and it spells out two distinct 404 outcomes (nonexistent revision vs. missing content snapshot). That error-shape disclosure is the kind of context annotations cannot carry.

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 short sentences with the core purpose front-loaded, followed by the return fields and the failure modes. Every clause carries information; there is no filler.

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?

For a two-parameter read with a full output schema and full annotation coverage, this is close to sufficient: errors are disclosed and the extra returned flags are flagged. The remaining gap is that it never relates the tool to listing revisions or to the restore flow, which an agent choosing among siblings would want.

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 doc_id and rev documented as path parameters, so the schema carries the load. The description only implies that rev selects one revision and adds no format or range detail beyond that, making the baseline 3 appropriate.

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?

The description states a specific verb and resource: reading the full text of one revision of a document, plus which fields come back (current_version, can_restore). This clearly separates it from a current-document read, but it never names the sibling tools (gwl_get_document, gwl_list_document_revisions, gwl_restore_document_revision), so the distinction has to be inferred.

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

Usage Guidelines3/5

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

Usage is only implied: the agent must already have a revision number to call it, and the description never says when to prefer this over listing revisions or fetching the current document. Nothing is misleading, but there is no explicit when/when-not guidance or pointer to alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.