generate_tof

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

No annotations are provided, so the description carries full burden for behavioral disclosure. It mentions inserting a field block and collecting captions, but does not explain what happens if the paragraph ID is invalid, whether the tool replaces an existing ToF, or any side effects like modifying other fields.

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 and front-loaded with the action: 'Insert a Table of Figures field block after the paragraph with para_id.' The second sentence adds necessary detail on what it collects, with no wasted words.

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 that an output schema exists (though not shown), the description need not detail return values. However, it lacks completeness in explaining behavior: no mention of error handling, whether it updates existing ToF fields, or the impact on the document structure. It is minimally adequate for a generative 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?

The input schema has 0% description coverage, so the description must compensate. It explains that 'para_id' identifies the paragraph after which to insert, and notes the default for 'title', but does not clarify what the 'title' parameter is used for (e.g., the caption label or heading). This adds some value but not full semantic coverage.

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 that the tool inserts a Table of Figures field block after a specific paragraph and collects caption-styled paragraphs starting with 'Figure'. It distinguishes itself from siblings like 'generate_list_of_figures' by specifying the insertion location and entry criteria.

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 does not provide any guidance on when to use this tool versus alternatives such as 'generate_list_of_figures' or 'update_toc'. It also lacks information on prerequisites or situations where the tool should not be used.

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