get_all_column_comments

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

With no annotations provided, the description bears full responsibility for behavioral disclosure. It adds one behavioral trait ('Each comment overrides the column name') but omits key behaviors such as handling empty results, pagination (limit/offset), or whether the tool is read-only. This is insufficient for a safe agent decision.

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?

A single sentence that conveys purpose and a critical behavioral note. It is not overly verbose, but the sentence is slightly packed; consider splitting for readability. Still very efficient.

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?

Output schema exists, so return value details are not required, but the description should at least mention that the tool returns a list or map of column comments. It also fails to address the presence of pagination parameters or the fact that it retrieves 'ALL' columns despite having limit/offset. Completeness is adequate but not thorough.

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?

Input schema has 4 parameters with 0% description coverage, and the tool description provides zero explanation for them. It does not clarify what 'schema_name' or 'table_name' represent, nor how 'limit' and 'offset' control pagination. An agent cannot infer correct usage solely from the description.

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 uses a specific verb ('Get') and resource ('authoritative comments for ALL columns in a table at once'), clearly distinguishing this tool from siblings like 'get_column_comment' (singular) and 'get_table_comment'. The phrase 'at once' emphasizes batch retrieval.

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?

No explicit guidance on when to use this tool versus alternatives (e.g., 'get_column_comment' for a single column). While the name and description imply it is for retrieving all column comments, there is no direct comparison or indication of prerequisites or exclusions.

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