Skip to main content
Glama

get_docx_structure_stats

Retrieve DOCX structure statistics including paragraph and word counts, tracked-change paragraph count, comment count, and file size to assess document complexity before processing.

Instructions

Return quick statistics for a DOCX: paragraph and word counts, tracked-change paragraph count, comment count and file size.

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": {
      "path": "<path>"
    },
    "name": "get_docx_structure_stats"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden, and it does disclose the shape of what is measured (counts and file size), which is the useful part. It says nothing about read-only safety, what happens for a missing or non-DOCX file, or cost beyond the vague 'quick', leaving real gaps for a file-processing tool.

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?

One front-loaded sentence that spends its words entirely on the resource and the returned metrics, with no padding or hedging.

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?

Because an output schema exists, the description need not explain return values, yet it still summarizes the metrics, which is a bonus. For a single-parameter read tool the only remaining hole is failure behavior on invalid paths or non-DOCX input.

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

Parameters2/5

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

Schema description coverage is 0% and the single 'path' parameter is undocumented. The description only implies the path points at a DOCX file; it does not specify absolute vs. relative paths, whether the file must exist locally, or how a wrong file type is handled.

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 ('Return quick statistics') and resource ('a DOCX') and enumerates exactly what is counted: paragraph/word counts, tracked-change paragraphs, comments, and file size. That metric list clearly distinguishes it from text-reading siblings like read_docx_accepted_text or find_docx_term, though no sibling is named explicitly.

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 by the word 'quick' — an agent can infer this is a cheap overview to run before pulling full text or paragraphs. There is no explicit when-to-use guidance, no statement of when a sibling tool is preferable, and no preconditions for the path.

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