netsuite_create_vendor_credit

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

No annotations provided, so description carries the burden. It discloses idempotency behavior via externalId and the ability to apply to bills, which is useful. However, it doesn't mention side effects, permissions, error behavior, or what happens on success, leaving some opacity for a mutation tool.

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, front-loaded with the main purpose. Every sentence adds value: purpose, idempotency guidance, and applyList option. No redundancy or fluff.

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 covers core use cases and idempotency, but for a complex tool with 8 parameters, nested objects, and no output schema, it omits mention of expenseList and dryRun. While the schema describes these, the description doesn't guide when to use them or what the response will be, leaving some gaps for an agent.

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 high (88%), but description adds value by explaining the purpose of externalId ('idempotency') and applyList ('apply to an existing bill'), which goes beyond the schema's field descriptions. It also clarifies the Spendesk credit note context, aiding parameter selection.

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 ('Create a NetSuite vendor credit') with a specific resource and purpose ('for Spendesk credit notes / refunds'). It distinguishes from sibling tools like netsuite_create_vendor_bill by framing this as a credit/refund operation.

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?

Provides concrete usage guidance: 'Use externalId for idempotency' with an example pattern, and 'Optionally apply to an existing bill via applyList'. This implies when to use these features, though it doesn't explicitly exclude alternative tools or state when not to use them.

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