smartsuite_list_records

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

Annotations declare readOnlyHint=true, so the description does not need to re-state safety. It adds token-saving tips but no additional behavioral traits like pagination behavior or rate limits. The description contributes marginal value beyond the annotations.

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 three sentences, each earning its place: purpose, prerequisite, optimization tip. No wasted words, clearly front-loaded, and efficiently structured.

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 read-only list tool with 8 parameters and no output schema, the description covers the response format (json vs compact), pagination (cursor), and a helpful prerequisite. It is mostly complete but could mention error handling or rate limits.

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 description coverage is high (88%), so the baseline is 3. The description adds usage advice (e.g., using compact format and fields projection to save tokens) but does not significantly enhance parameter meanings beyond what the schema already provides.

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 'List records from a SmartSuite application' with a specific verb and resource. It also hints at a prerequisite using another tool, which adds clarity. Although siblings like smartsuite_search_records exist, the purpose is unambiguous and well-defined.

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 explicitly advises using smartsuite_describe_application first to learn field slugs and recommends using format:"compact" with a fields projection for large result sets. It provides clear context on when to use certain parameter options but does not exclude alternative tools like search_records.

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