Skip to main content
Glama

read_document

Extract text, comments, and track changes from Word documents to review revisions and feedback.

Instructions

Read a Word document and extract content, comments, and track changes.

Args: path: Path to the .docx file include_text: Include full document text (default: True) include_comments: Include comments with anchors (default: True) include_track_changes: Include insertions/deletions (default: True)

Returns: Dictionary containing: - metadata: Document metadata (path, author, created, modified, word_count) - paragraphs: List of paragraphs with index, text, and style - comments: List of comments with id, author, date, text, anchor_text, anchor_paragraph, resolved (boolean), and replies - track_changes: List of track changes with id, type (insertion/deletion), author, date, text, paragraph

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
include_textNo
include_commentsNo
include_track_changesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

No annotations provided, but the description explains the return value structure in detail (metadata, paragraphs, comments, track_changes). It covers parameters and defaults. No mention of error handling, but adequate for a read operation.

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?

Well-structured with sections for Args and Returns, front-loaded with purpose. Could be slightly more concise, but no wasted sentences.

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?

Given no output schema, the description provides a detailed return structure (metadata, paragraphs, comments, track_changes). The tool's purpose is fully covered in context of sibling tools.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, but the description adds full parameter semantics: path required, include_text/comments/track_changes with defaults and what they control. This significantly adds value beyond the 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?

The description clearly states 'Read a Word document and extract content, comments, and track changes', specifying verb and resource. It distinguishes from sibling tools like accept_change and create_comment, which are mutational.

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?

The description implies reading vs. modifying, but does not explicitly state when to use or when not to use alternatives. No exclusions or when-to-use guidance.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kosh-jelly/docx-comments-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server