Create IT Glue Document Section

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

Annotations indicate this is a write operation with possible side effects (openWorldHint true) but not destructive. The description adds value by disclosing the behavior of inline images in HTML (rendering depends on IT Glue's sanitization) and explicitly distinguishing between inline images and attached files. There is no contradiction with annotations.

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 is concise, with three sentences covering purpose, type details, and a caveat. It is front-loaded and efficiently communicates essential information without redundancy.

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 no output schema, the description adequately covers input behavior and special conditions. It could be improved by briefly mentioning what the return value contains (e.g., the created section object), but the context is largely complete for a creation tool.

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 coverage is 100% with descriptions for all 7 parameters. The description enriches meaning by explaining how parameters relate to section types (e.g., level required for Heading, duration for Step, content semantics vary by type).

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 'Add a section to a document' and specifies four types with distinct behaviors. It also differentiates from the sibling tool itglue_create_attachment by explicitly noting that to attach image files, use that tool.

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 provides explicit when-to-use guidance by detailing section types and their required/optional parameters. It also tells when not to use (for attaching image files) and suggests the alternative sibling tool.

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