Get Report Data

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

Annotations already declare readOnlyHint=true and destructiveHint=false. Description adds valuable behavioral context: reports aggregate rows from multiple source sheets, supports pagination for large row counts, and returns source sheet context. No contradiction with 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?

Front-loaded purpose, clear structure with paragraphs and Args list. No unnecessary words, but the description is moderately long. Could be slightly trimmed without losing meaning.

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 tool with 4 parameters and no output schema, the description covers report nature, pagination, and return context. Missing explicit details on how source sheet context appears or how to handle multi-sheet rows, but sufficient for most uses.

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 50% (report_id and level have descriptions). Description repeats defaults for page_size and page but adds no new meaning. The 'level' description in the schema is more precise (includes max 2), while the description omits that, making it slightly less helpful.

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?

Description clearly states 'Retrieve data from a Smartsheet report by ID' with a specific verb and resource. It distinguishes from siblings like smartsheet_get_sheet and smartsheet_list_reports by explaining reports aggregate rows from multiple sheets.

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?

Description explains report characteristics and pagination but does not explicitly guide when to use this tool versus alternatives like smartsheet_get_sheet or smartsheet_search. No 'use this when' or 'instead of' statements for sibling differentiation.

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