netsuite_upload_file

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

With no annotations, the description carries the burden of disclosing behavior. It states the upload side effect, the return value (file internal ID), and parameter requirements (base64 content, folder ID). However, it omits details like file size limits, duplicate-name behavior, or permission requirements, leaving some behavioral ambiguity.

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 sentences: the first states the core action, the second lists required and optional parameters. It is front-loaded with the primary purpose and contains no redundant words. All information earns its place.

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 has 6 parameters, no output schema, and no annotations, the description covers the essential context: purpose, return value, required parameters, and a downstream usage example. It lacks error handling or permission details, but for an upload tool it is reasonably complete for an agent to select and invoke it.

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 description adds semantic meaning beyond the schema by clarifying that 'content' must be base64-encoded, 'folder' is the NetSuite File Cabinet folder internal ID, and 'fileType' is like 'PDF'. It also notes the optionality of description and isOnline. The schema coverage is 67%, and the description helps fill gaps for the optional fields, though it could explain their meaning more deeply.

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 explicitly states 'Upload a file to NetSuite File Cabinet' with a concrete example ('invoice PDF'). It clearly distinguishes the tool by mentioning it returns the file internal ID for use with netsuite_attach_file_to_record, which separates it from listing or attaching operations.

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 description gives clear usage context: it is for uploading files that will later be attached to records, evidenced by 'Returns the file internal ID for use with netsuite_attach_file_to_record.' It also lists required and optional parameters, but does not explicitly mention when not to use it or name alternative tools beyond the attach sibling.

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