insert_text_box

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

No annotations provided; description discloses insertion and return format but lacks details on error conditions, prerequisites, or side effects like permissions needed.

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?

Description is well-structured with a concise first line and organized parameter details. Slightly verbose due to docstring format but no unnecessary content.

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?

Completeness is good for an insert tool: explains purpose, parameters, and return value. Missing output schema but returns JSON described. No mention of prerequisites, but adequate for typical use.

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%, but the description's Args section explains all four parameters with roles and defaults, fully compensating.

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?

Description clearly states 'Insert an inline text box after the paragraph with para_id', specifying the action, resource, and context. It differentiates from other insert tools like insert_text or insert_image.

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 implies usage context (insert after a paragraph) but does not provide explicit guidance on when not to use or compare to alternatives among many sibling tools.

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