wafeq_invoices_create

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

Annotations already carry readOnlyHint=false and idempotentHint=false, but the description adds genuine value beyond them: it explains the concrete consequence of non-idempotency ("calling twice creates two records") and prescribes the mitigation (pass idempotency_key or let the server generate one for safe retries). The WRITE warning is consistent with readOnlyHint=false. This is meaningful behavioral context, though it stops short of covering auth or rate-limit behavior.

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 short and the idempotency warning is genuinely useful, but it contains redundancy: "Create invoice", "Endpoint for creating a new invoice", and the header's "Invoices · POST /invoices/" all say essentially the same thing. The emoji-prefixed header also duplicates what the annotation title already provides. Tightening to the endpoint line plus the non-idempotency note would earn a higher score.

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 complexity — a large nested body with roughly 25 fields and nested line_items with revenue_recognition — the description is brief, but the 100%-coverage schema compensates heavily. There is no output schema and the description says nothing about the success response or what the created invoice object contains, which is a real gap for a creation endpoint. Core purpose and the key behavioral caveat are covered, making it adequate but not complete.

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 description coverage is 100%, so the baseline is 3; the schema already thoroughly documents every body field and the idempotency_key parameter, including the X-Wafeq-Idempotency-Key header and auto-generated UUID behavior. The description's mention of idempotency_key largely restates the schema's richer explanation rather than adding new parameter semantics. It neither harms nor meaningfully extends the schema's documentation.

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 a specific verb and resource: "Create invoice" with endpoint "POST /invoices/", and the header line "WRITE · creates data · Invoices" reinforces this. It is readily distinguishable from the update/retrieve/list/destroy invoice siblings, though it never names a sibling explicitly. Close cousins like wafeq_simplified_invoices_create and wafeq_quotes_invoice_create exist and are not explicitly differentiated, so it stops short of a 5.

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 context is clear: this is the endpoint for creating a new invoice, and the non-idempotency warning implies it is for fresh creation rather than updating an existing record. No exclusions or alternative-tool routing are provided, but for a straightforward create endpoint the usage context is self-evident from "Create invoice" and the POST path.

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