Skip to main content
Glama

write_word_document

Generate Word documents in DOCX or DOC format with structured content including titles, paragraphs, and tables for automated document creation.

Instructions

Generates a Word document in DOCX format, or DOC via LibreOffice conversion.

:param filename: Target output path ending with .docx or .doc :param title: Optional document title :param paragraphs: Optional paragraph list written in order :param tables: Optional table definitions using title, headers, and rows :return: JSON payload describing the generated file path and format

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filenameYes
titleNo
paragraphsNo
tablesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions the tool generates documents and returns a JSON payload, but lacks details on permissions, error handling, rate limits, or side effects. For a write operation with zero annotation coverage, this is a significant gap in transparency.

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 appropriately sized and front-loaded, starting with the core purpose. Each sentence adds value: format details, parameter explanations, and return information. There's minimal waste, though the parameter list could be more integrated into the narrative flow.

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?

Given the tool's complexity (4 parameters, write operation) and no annotations, the description covers purpose, parameters, and return value. With an output schema present, it doesn't need to explain return values in detail. It's mostly complete but could improve on behavioral context and usage guidelines.

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 0%, so the description must compensate. It lists all four parameters with brief explanations (e.g., 'Target output path ending with .docx or .doc'), adding meaning beyond the schema. However, it doesn't fully detail parameter constraints or formats, leaving gaps like table structure specifics.

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 the tool's purpose: 'Generates a Word document in DOCX format, or DOC via LibreOffice conversion.' It specifies the verb ('Generates'), resource ('Word document'), and format details, distinguishing it from sibling tools like extract_document_images (extraction), read_document (reading), and write_presentation (different document type).

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention sibling tools like write_presentation for presentations or read_document for reading documents, nor does it specify prerequisites or contexts for choosing this tool. Usage is implied but not explicitly stated.

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/crispvibe/mcp-document-studio'

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