extract_zugferd

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

No annotations provided; description only states extraction and return of JSON. Does not disclose error handling, side effects, or requirements like file format validity.

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?

Short description with clear Args/Returns sections. No redundant information, though could include more behavioral details without excessive length.

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?

Tool has output schema (implied by 'Returns JSON'), so return structure is covered. However, lacks usage context and behavioral traits, leaving gaps for a new user.

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?

Single parameter 'pdf_base64' has 0% schema description coverage; description adds meaning by specifying it is 'Base64-encoded ZUGFeRD PDF', compensating for the schema gap.

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 'Extract structured invoice data from a ZUGFeRD/Factur-X PDF', using a specific verb and resource. It distinguishes from siblings like validate_zugferd and parse_xrechnung by focusing on extraction.

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 guidance on when to use this tool versus alternatives (e.g., validate_zugferd might be used for validation). No mention of prerequisites or exclusions.

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