Skip to main content
Glama

insert_paragraphs

Insert paragraphs into Word documents at a specified location, with optional formatting and heading levels. Supports live editing, tracked changes, and validated saves to keep documents accurate.

Instructions

Insert paragraphs (items {text, style?, formatting?, heading_level?}) at a location object (omitted = document end). heading_level 1-9 makes the item a heading (level 1 = outline 0). inherit_format/copy_format_from clone neighbor formatting minus outline level (file mode only); track records insertions by author. Auto-backup in file mode; atomic validated save. Open documents edit live, serialized; a stale text-selector target refuses: save in Word, retry. For batches, use apply_edits.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
liveNoauto
trackNo
authorNoClaude
backupNo
locationNo
file_pathYes
paragraphsYes
inherit_formatNo
copy_format_fromNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv2.0.0
    • removedInput schema / properties / after_anchor
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null
      -}
    • removedInput schema / properties / after_index
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "integer"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null
      -}
    • removedInput schema / properties / at_end
      Removed value: -{
      -  "default": false,
      -  "type": "boolean"
      -}
    • removedInput schema / properties / before_index
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "integer"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null
      -}
    • addedInput schema / properties / location
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": true,
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null
      +}
  2. Changed3 schema fields changedv1.6.1
    • addedInput schema / properties / copy_format_from
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null
      +}
    • addedInput schema / properties / inherit_format
      Added value: +{
      +  "default": false,
      +  "type": "boolean"
      +}
    • addedInput schema / properties / live
      Added value: +{
      +  "default": "auto",
      +  "type": "string"
      +}
  3. First observedv1.2.1

TDQS

A4.8/5.0
Behavior5/5

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

Even though annotations only say readOnlyHint=false, the description discloses substantial behavior: insertion with heading handling, format cloning minus outline level, track changes by author, auto-backup, atomic validated save, serialized live editing, and refusal of stale targets. This goes well beyond the minimal annotation signal and accurately reflects a mutating 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?

The description is dense but every clause adds operational value. It front-loads the core insertion semantics and then covers modes, safety, live-editing behavior, troubleshooting, and batch routing without wasted words.

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?

For a 9-parameter tool with no schema descriptions, the description provides substantial operational grounding, and the output schema can cover return-value details. Minor gaps remain: the location object shape is not specified, copy_format_from's integer target is ambiguous, and the live parameter values are not enumerated. Still, the description is largely complete for successful invocation.

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

Parameters4/5

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

Schema description coverage is 0%, so the description carries the burden, and it covers most parameters well: paragraphs item fields, heading_level semantics, location default, inherit_format/copy_format_from, track, author, and backup. However, copy_format_from's expected integer meaning is not fully explained, and the exact accepted values for the live parameter are only implied.

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 names a specific operation and resource: inserting paragraph items, and goes beyond the tool name by specifying the item shape ({text, style?, formatting?, heading_level?}) and the location semantics. It also distinguishes itself from apply_edits by noting that batches should use that sibling.

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 explicitly states when to prefer an alternative: 'For batches, use apply_edits.' It also provides mode-specific guidance, such as file mode limitations for format cloning, live editing behavior for open documents, and how to recover from a stale text-selector target. This gives an agent concrete selection and troubleshooting context.

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