Skip to main content
Glama

Reverse-engineer a format file from a .docx

extract_format_from_docx

Reads a reference .docx template and produces a draft format file, listing detected values and items to confirm before compiling.

Instructions

Read a reference .docx template (institution, journal, or organization) and produce a draft format file. The draft lists every value it could determine and a 'to confirm' list it could not; review those before compiling.

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": {
      "docx_path": "<docx_path>"
    },
    "name": "extract_format_from_docx"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNozh
docx_pathYes
output_pathNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description does carry real behavioral information: the result is deliberately partial, split into determined values and a 'to confirm' list, and requires human review. It says nothing about whether a file is written to disk, whether an existing file at the target path is overwritten, or how failures on a non-template .docx surface.

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?

Two sentences, front-loaded with the action and closing with the review expectation. Nothing is redundant, though the second sentence could be tightened.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return-value detail is not required. However, for a three-parameter file-producing tool with zero schema coverage and no annotations, the definition leaves the path and language parameters, and any write side effects, unaddressed.

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%, so the description must compensate and it does not: docx_path, output_path, and lang (defaulting to zh) are never mentioned or explained. It also does not clarify whether a missing output_path implies a default location or a returned-only draft.

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: read a reference .docx template and produce a draft format file. That distinguishes it from the compile/validate siblings, which operate on already-authored content. It stops short of naming those alternatives 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: it is for bootstrapping a format from an existing institution/journal/organization template, and the output is meant to be reviewed before compiling. There is no explicit when-to-use/when-not statement and no routing to inspect_preset or list_presets for existing formats.

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