Skip to main content
Glama

render_docx_preview

Render a Word document (.docx) in the project to per-page PNG images (written under /.docx-preview/), so you can study its VISUAL LAYOUT — heading levels, font styles, table/figure placement, margins — with analyze_image before replicating the formatting in LaTeX. Pair with extract_docx_text for the actual content. Requires the render-worker service; when it reports unavailable, fall back to extract_docx_text alone.

Input Schema

NameRequiredDescriptionDefault
pathYes
project_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Since no annotations are provided, the description must carry the full behavioral burden. It specifies the output structure (PNG images written under /.docx-preview/), identifies the required external service (`render-worker`), and defines the fallback mechanism if that service fails.

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 description is densely packed with necessary information, but the first sentence is long. However, the logic flows clearly: Goal > Deliverables > Workflow > Contingency, making it very effective.

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 the lack of annotations and the complexity (rendering, external worker dependency, specific file paths for output, and fallback logic), this definition is exceptionally complete. It covers operational requirements and specific failure modes.

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?

While the description provides rich context for the resource being acted upon (a Word document in the project), it adds no specific semantic meaning to the input keys (`path`, `project_id`) beyond what a basic string schema provides. It falls into the minimum viable category when structural coverage is assumed.

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 explicitly states the action: 'Render a Word document... to per-page PNG images.' Crucially, it distinguishes this from `extract_docx_text` by framing the goal as analyzing visual layout rather than extracting content.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It not only states the primary use (studying visual layout) but also provides explicit instructions on workflow, advising the agent to 'Pair with extract_docx_text for the actual content.' It also dictates operational rules regarding service availability.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources