Skip to main content
Glama

Document Append Paragraph

document_append_paragraph
Destructive

Use this to append a user-provided paragraph to a specified local word-processing document. Verify the path and creation option; this writes document content.

Input Schema

NameRequiredDescriptionDefault
pathYesExisting .docx path, or the new document destination when create=true.
textYesParagraph text to append/prepend/insert.
createNoCreate a new DOCX at path. Fails if path already exists; do not combine with output.
deviceYesReMCP device id returned by list_devices. Required for every device operation.
outputNoOptional output .docx path when editing an existing document.

Output Schema

NameRequiredDescriptionDefault
dataNoEdit DOCX document structured result for edit_document. Stable fields are declared explicitly; platform-specific fields may be added. Large results may return truncated/bytes/preview instead of the full payload.
textYesConcise human-readable result of the tool call.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false and readOnlyHint=false; the description's 'this writes document content' merely restates that. It adds the useful caution to verify path and create flag, but it never explains why the tool is flagged destructive (e.g., the create path semantics), leaving the agent with the annotation's warning but no cause.

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 short sentences with the mutation warning front-loaded in the second clause. 'Use this to' is mild filler but nothing bloats the definition.

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 and annotations carry safety flags, so return values need no explanation. What is missing is routing information in a dense sibling cluster of paragraph-editing tools and any note on how the destructiveHint relates to the create flag, which is required to call it safely.

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 100%, so all five parameters are already documented, including the create/output conflict rule. The description contributes only the reminder to verify 'the path and creation option', which is a workflow hint rather than new semantics, so the schema-based baseline of 3 applies.

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?

Names a specific verb and resource ('append a paragraph to a local word-processing document'), so the operation is unambiguous. However, it never distinguishes itself from close siblings such as document_prepend_paragraph, document_insert_paragraph_before/after, or document_replace; the agent must infer the distinction from the name alone.

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 phrase 'Verify the path and creation option' implies a precondition check, and 'user-provided paragraph' hints that the text is not generated. But there is no explicit when-to-use versus the four sibling paragraph-editing tools, nor any statement about when not to call it.

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