generate_job_invoice

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

Discloses that it is gated behind an environment variable and returns an error if not enabled, and that it creates a billable customer-facing invoice. Without annotations, this provides useful behavioral context beyond just the action.

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?

Three sentences, no redundancy. Front-loaded with the main action. The gating condition is relevant but could potentially be integrated more succinctly.

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 the tool's simplicity (one parameter, no output schema), the description covers the core purpose, a key behavioral gate, and the nature of the invoice created. Missing details like success response or effects on job status but acceptable for a straightforward action.

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 100% with parameter description 'Active job ID to invoice'. The tool description reinforces 'active' but adds minimal meaning beyond the schema for the single parameter.

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 states 'Post an official invoice against an active job,' clearly indicating the verb, resource, and context. It distinguishes from siblings like create_estimate or schedule_new_job which serve different purposes.

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 or alternatives. The description mentions a gating env var but does not specify situations where this tool is appropriate versus other invoicing or billing tools.

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