describe_table

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

No annotations provided, so description bears full burden. Discloses caching behavior and refresh capability, and states what is excluded. Is a read operation implicitly. Lacks explicit safety statements but is transparent.

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?

Two sentences, front-loaded with purpose, no filler. Each sentence adds value (purpose, exclusions, refresh). Highly concise.

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?

Has output schema so return details not needed. Describes included and excluded content, refresh behavior. Could mention permission requirements but not critical. Generally complete for a schema description tool.

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?

100% schema coverage, so baseline 3. Description adds no additional meaning beyond schema: 'schema.table' disambiguation is already in schema param description, and refresh behavior is also in schema. No extra context for 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?

Clearly states it describes one table's columns, types, primary key, and foreign keys. Distinguishes from sibling list_tables (lists names only) and query_db (runs queries) by scoping to a single table and including 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?

Implies use for authoring correct queries, mentions excluded features (indexes, comments), and explains refresh behavior. Does not explicitly compare to alternatives but provides clear context.

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