list_sql_endpoints

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

No annotations are provided, so the description carries the full burden. It mentions listing behavior and parameter interaction, but does not disclose permissions, error handling, or potential side effects. The read-only nature is implied but not explicitly confirmed.

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 extremely concise: two sentences for the main purpose and a clear block explaining arguments. No unnecessary words or redundancy.

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 presence of an output schema (implied but not shown), the description covers the basic function and parameter logic. However, it could be more complete by including a note about permissions or typical use cases to differentiate from siblings.

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?

Since schema description coverage is 0%, the description adds significant value by explaining the relationship between 'workspace' and 'all_workspaces' (workspace optional when all_workspaces is True). This goes beyond the schema which only provides types and defaults.

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 lists all SQL analytics endpoints in a workspace, using a specific verb('List') and resource('SQL analytics endpoints'). It distinguishes itself from siblings like 'list_sql_pools' or 'list_warehouses' by the specific resource type.

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 explains the conditional usage of the 'workspace' and 'all_workspaces' parameters, but does not provide guidance on when to use this tool over alternatives like 'get_sql_endpoint' or other listing tools. No explicit when-not or alternative suggestions are given.

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