Get All Column Comments

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

No annotations are provided, so the description carries the full behavioral burden. 'Get' implies a read operation, and 'Each comment overrides the column name' adds useful behavioral context, but pagination behavior, limit/offset effects, and output details are not disclosed.

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 concise and front-loaded with the main action. The second sentence adds behavioral context, though 'overrides' is terse and could be more explicit.

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?

An output schema exists, so return-value documentation is not the description's responsibility. However, with no annotations, no usage guidance, and no parameter semantics, the definition is only minimally complete for a tool with four parameters.

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%, and the description does not mention schema_name, table_name, limit, or offset. With no parameter descriptions in the schema and no compensation in the description, the agent receives no added semantic meaning for 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 the verb ('Get'), resource ('authoritative comments'), and scope ('ALL columns in a table at once'). It distinguishes from the singular get_column_comment sibling by emphasizing the bulk nature, though it does not explicitly name the alternative.

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 phrase 'ALL columns in a table at once' implies this is for bulk retrieval rather than fetching a single column comment, but no explicit when-to-use or when-not-to-use guidance is given. Sibling tools like get_column_comment are not referenced, leaving the agent to infer the tradeoff.

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