VendorDirectFulfillmentShipping20211228_getCustomerInvoice

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

With no annotations, the description carries the full burden. It reveals that execution occurs in a Kuudo deployment and that it returns a result, but it fails to state whether the operation is read-only, what the response format looks like, or how errors are surfaced. The 'Catalog entry' phrase adds confusion rather than clarity.

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 compact at two sentences, front-loading the deployment caveat before the core capability. The phrase 'Catalog entry' is somewhat cryptic but not verbose; overall it is concise without 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?

For a tool with no output schema and no annotations, the description is underspecified. It omits the return payload structure, the exact way to specify purchaseOrderNumber, and any behavioral safeguards. The deployment note helps but does not offset the missing fundamental invocation details.

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 declares zero parameters and allows additional properties, yet the description introduces purchaseOrderNumber as a meaningful parameter. With no schema-defined params, the baseline is 4, and the description provides the only parameter hint. However, it does not specify the parameter's type, requiredness, or how it should be passed.

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 tool returns a customer invoice and identifies the key lookup key (purchaseOrderNumber). However, it does not distinguish this 20211228 version from the V1 sibling with the same name, making selection between versions ambiguous.

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 is given about when to use this tool versus the many similarly named siblings (e.g., the V1 variants or the plural 'getCustomerInvoices'). The 'Runs in your Kuudo deployment, not here' note provides deployment context but not usage criteria.

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