list_columns

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

With no annotations provided, the description must disclose behavioral traits. It mentions optional comment inclusion but omits what happens if the table does not exist, whether the operation is read-only, or any pagination behavior for limit/offset.

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 a single, efficient sentence that front-loads the core purpose. It adds detail on optional parameters without verbosity.

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?

Despite having 6 parameters, the description only covers 2 boolean ones. It does not clarify that limit/offset are for pagination, and the output schema (even if present) is not referenced to explain return structure. Sibling list_tables could cause confusion without differentiation.

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%, yet the description only explains include_comments and include_parent_comments with their defaults. Required parameters schema_name and table_name, plus limit and offset, lack any explanation, leaving ambiguity.

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 'List columns (name, type, nullable) in a table', specifying the verb, resource, and key attributes. It distinguishes from siblings like get_column_comment (retrieves a single comment) and search_columns (searches across tables).

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 provides no guidance on when to use this tool versus alternatives like execute_sql, search_columns, or list_tables. It does not mention typical use cases or conditions to avoid.

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