docx-insertContent

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

No annotations are provided, so the description carries full burden. It only states 'Insert a block at index' without disclosing side effects (e.g., mutation), error handling, or return behavior. This minimal disclosure leaves significant behavioral gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description consists of two concise sentences: the first states the purpose, the second provides usage guidance. No extraneous information; every sentence serves a clear function.

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

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

Given 3 parameters, no output schema, and no annotations, the description provides the core purpose and prerequisite steps but lacks detail on parameter semantics and behavioral outcomes. It is adequate for understanding scope but leaves gaps for an agent to infer required information.

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

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

Schema description coverage is 0% (no parameter descriptions in schema). The description references docx-getSchema for block structure but does not explain the 'id' or 'index' parameters. It adds little meaning beyond the schema's type definitions, failing to compensate for the lack of schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Insert a block at index', specifying the verb (insert) and resource (block at index). It distinguishes from sibling tools like docx-create (creates new document) and docx-removeContent (removes content) by implying insertion of new content into an existing structure.

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

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

The description explicitly advises to use docx-queryObjects first to see current structure and docx-getSchema to understand block structure, providing clear context for when to use this tool. However, it does not include explicit exclusions or alternatives beyond referencing other tools as prerequisites.

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