insert_caption

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

With no annotations, description carries full burden. It explains text excludes label/number prefix and label default, but omits key behaviors like auto-numbering, validation of after_para_id, or effects on cross-references.

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?

Concise single paragraph with main action upfront, followed by clear parameter descriptions. No redundant information.

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?

Adequately covers core purpose and parameters given output schema exists (not shown). Lacks details on behavior for invalid inputs or numbering, but acceptable for a simple insertion 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 0%, but description adds meaningful explanations for all parameters: after_para_id as paraId to insert after, text as caption description without prefix, label as caption label with example. Adds significant value beyond schema.

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?

Clearly states 'Insert a caption paragraph after the specified paragraph.' with specific verb and resource. Distinguishes from siblings like 'insert_paragraph' (generic) and 'add_cross_reference' (different action).

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?

No explicit guidance on when to use vs alternatives. Does not mention prerequisites or cases where other tools (e.g., insert_paragraph) might be more appropriate.

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