netsuite_get_vendor_by_id

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

No annotations are provided, so the description bears the full responsibility for behavioral disclosure. It mentions that the tool returns full vendor details with expanded sub-resources, which is useful behavioral information, but it does not disclose potential errors, authentication requirements, or rate limits. For a read operation, this is minimally adequate but not rich.

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 two concise sentences, front-loaded with the primary action, and every sentence adds value. There is no redundancy or filler.

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 simple 1-parameter get tool, the description is nearly complete: it states the input, the output, and the distinguishing aspect of internal ID. However, 'expanded sub-resources' is a bit vague and could benefit from clarification, and the lack of an output schema places slightly more burden on the description.

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 schema only provides a string type for 'id' with no description. The description compensates fully by explaining 'id' is the 'NetSuite internal vendor ID', adding meaningful semantic context beyond the schema.

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 retrieves a single NetSuite vendor by internal ID, using a specific verb and resource. It distinguishes itself from sibling netsuite_get_vendor_by_external_id by explicitly mentioning 'internal ID'.

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 phrase 'by internal ID' indicates when this tool should be used versus the external ID variant, providing clear context. However, it does not explicitly name alternatives or state when not to use the tool, so it lacks explicit exclusions.

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