describe_table

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

No annotations provided; description discloses automatic uppercasing of table name and explains behavior of brief and filter parameters. Lacks mention of permissions or error conditions, but adds some behavioral context.

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?

Three sentences efficiently front-load purpose, then explain parameters. No redundancy; every sentence adds value.

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 no output schema, description adequately explains return values for both brief and full modes. Lacks explanation of error handling or edge cases, but overall complete for the tool's purpose.

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 0% coverage, but description provides detailed semantics for all 4 parameters: source and behavior for database and table, effect of brief on return fields, and regex filtering for filter.

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?

Description clearly states it returns column definitions for a table or view, with specific verb and resource. It distinguishes from sibling tools that analyze indexes, foreign keys, etc., by focusing on schema details.

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?

Provides guidance on how to obtain values for database and table parameters (from list_databases and list_objects). Does not explicitly state when not to use it versus alternatives, but context is clear enough.

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