Skip to main content
Glama

extract_revisions

Read-only

Extract tracked changes from DOCX/ODT files as structured JSON, including before/after paragraph text, revision details, comments, and row changes. Read-only, with pagination.

Instructions

Extract tracked changes as structured JSON with before/after text per paragraph, revision details, and comments. Table rows inserted or deleted as a whole, and row property changes (w:trPr > w:ins / w:del / w:trPrChange), are reported as records with scope "row", keyed by the row's first paragraph, whose revisions are ROW_INSERTION / ROW_DELETION / FORMAT_CHANGE entries carrying the revision id, author and date. Supports pagination via offset and limit. Read-only - does not modify the document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax entries per page (1-500). Default: 50.
offsetNo0-based offset for pagination. Default: 0.
file_pathYesPath to the DOCX or ODT file.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.12.1
    • changedInput schema / properties / file_path / description
      Previous value: -"Path to the DOCX file."New value: +"Path to the DOCX or ODT file."
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description confirms the read-only nature while adding real behavioral detail: how row-level insertions/deletions/format changes are surfaced with scope "row" and ROW_INSERTION/ROW_DELETION/FORMAT_CHANGE records, and that pagination is supported. This goes beyond what the annotations convey.

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

Conciseness4/5

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

The main purpose is front-loaded in the first sentence, followed by necessary detail on row-scope records and pagination. The middle sentences are dense and technical but each carries useful semantics rather than 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?

With no output schema, the description carries the burden of explaining return values, and it does so well (before/after text, revision details, comments, row-scoped records). The only minor gap is that it doesn't restate accepted file types (DOCX/ODT, which the schema covers) or the author/date fields' format.

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%, so file_path, offset, and limit are already documented with ranges and defaults. The description only notes that pagination exists via offset and limit, adding no syntax or format detail beyond the schema; baseline 3 applies.

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 (Extract) and resource (tracked changes) plus the output shape (structured JSON with before/after text per paragraph, revision details, comments). Clear enough to distinguish from the sibling has_tracked_changes, which only checks presence.

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 implied by the purpose but never stated as when/when-not. It does not route the agent to siblings such as has_tracked_changes (to check first) or accept_changes/reject_ai_edits (to act on the revisions), so no explicit selection guidance is given.

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