generate_tof

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

The description discloses that it inserts a field block after a specific paragraph and collects captions, but it does not cover side effects, permission requirements, or what happens if the paragraph or captions are missing. With no annotations, more detail would be beneficial.

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?

Two concise sentences that front-load the action and resource. Every word is informative, no redundancy or filler.

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?

The description is adequate for a simple tool with an output schema. It explains the main purpose and key behavior, but lacks details on edge cases (e.g., no captions, missing paragraph) and return value structure, though the output schema likely covers the latter.

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 description adds meaning to 'para_id' (identifies where to insert) and 'title' (heading for the TOF), but given 0% schema coverage, it only partially compensates. It does not explain the format or constraints of the parameters beyond what is obvious.

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 the action 'Insert a Table of Figures field block', specifies the resource 'after the paragraph with para_id', and explains the behavior 'Collects caption-styled paragraphs starting with "Figure" as entries'. It distinguishes from siblings like 'generate_list_of_figures' and 'generate_toc' by being more specific.

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 for inserting a Table of Figures, but it does not explicitly state when to use this tool versus alternatives like 'generate_list_of_figures' or 'generate_tot'. No exclusions or conditions are provided.

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