smartsuite_export_diff

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

Annotations already provide readOnlyHint=true, so the bar is lower. The description adds that the tool creates files (XLSX, JSON) and returns their paths, which is useful behavioral context beyond what annotations convey. Could be more explicit about the operation being non-destructive.

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?

Two sentences with no wasted words. Front-loaded with the step number and key purpose. Every sentence earns its place, providing purpose, format details, prerequisite, and return value.

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, the description adequately explains that it returns file paths. It also specifies the output formats and the prerequisite. Given the tool's role in a multi-step process, the description is 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 coverage is 100%, so the schema already describes both parameters (format and project). The description does not add extra meaning beyond the schema, which is adequate given the baseline for high coverage.

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 renders a project diff as XLSX and JSON, specifies it's Step 4 of solution migration, and names a prerequisite (smartsuite_diff_schemas). This distinguishes it from sibling tools like form or record 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?

Explicitly advises to run smartsuite_diff_schemas first, providing clear sequential context. Also mentions it returns file paths, helping the agent understand what to expect after invocation.

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