Skip to main content
Glama

修订历史

gwl_list_document_revisions
Read-onlyIdempotent

Lists a document's revision history with revision numbers, editors, summaries, content flags, and timestamps, excluding full text; retrieve a specific version's content separately.

Instructions

列出文档的修订历史(裸数组:revision_num、editor_username、summary、has_content、created_at)。 不含正文;取某一版全文用 gwl_get_document_revision。

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>"
    },
    "name": "gwl_list_document_revisions"
  }
}

Input Schema

NameRequiredDescriptionDefault
doc_idYes文档 id(路径参数)。

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

注解已经声明了安全性(readOnlyHint=true、idempotentHint=true、destructiveHint=false),因此描述不需要再说明操作的安全性。描述在注解之外还补充了语义边界:结果中不返回正文,并且返回的是裸数组。它没有补充分页、排序顺序或结果数量上限,而这些对修订列表来说是有意义的。

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?

两句话的简短结构,没有多余内容:先给出动作和返回结构,再给出替代工具的路由。它一口气写完了,而且先讲了关键内容,没有多余的客套话。

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?

考虑到这是只有一个参数、且有输出 schema 的只读列表工具,描述已经足够:用途、正文范围排除和同系列工具路由都在其中,返回结构由输出 schema 负责。智能体调用它所需的信息没有缺失。

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 描述覆盖率为 100%,且唯一参数 doc_id 已在 schema 中记录为路径参数(最小值为 1)。描述完全没有补充参数的语义,因此适用基线 3——schema 承担了全部工作。

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?

“列出文档的修订历史”具体定义了动词和所操作的资源,随后立即给出返回字段(revision_num、editor_username、summary、has_content、created_at)。它还明确排除了 gwl_get_document_revision 的行为(“不含正文”),因此智能体无需打开另一个 schema,就能判断这两个工具分别适用什么场景。

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?

它明确指定了同系列工具作为替代方案:“取某一版全文用 gwl_get_document_revision”,并给出了触发条件(需要某一版的正文内容)。它没有说明权限前提,也没有说明什么时候完全不应使用该工具(例如文档不存在,或不需要修订历史),因此距离完整路由还差一点。

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