List Workspaces

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is clear. The description adds value by specifying the return type (workspace name, ID, access level, child resource counts) and pagination details (page_size, page), which goes beyond what annotations provide.

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 very concise: one sentence for purpose, one for return fields, then two lines for parameters. No filler. Front-loaded with the main action.

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 list operation with no output schema and two optional parameters, the description is complete. It covers return structure, pagination, and scope. No additional context is needed for an agent to invoke it correctly.

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 0%, so the description carries the burden. The Args block explains page_size and page with defaults and optionality, adding meaning beyond the schema's type and constraints. It does not describe all possible values but adequately explains the parameters.

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 it lists all Smartsheet workspaces the authenticated user has access to, using a specific verb 'list' and resource 'workspaces'. It distinguishes from siblings like smartsheet_browse_workspace (which navigates a single workspace) and smartsheet_list_sheets (lists 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?

The description states it lists all workspaces, which is clear context for usage. It does not explicitly mention when not to use or compare to alternatives like smartsheet_browse_workspace, but the sibling set makes the distinction implicit.

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