Describe Table

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

With no annotations, the description must carry the full burden of behavioral disclosure. It lists the output categories (columns, types, keys, indexes) but does not explicitly state that the operation is read-only, requires table existence, or detail error conditions. The verb 'Show' implies a read operation but is not explicit.

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, grammatically complete sentence that is front-loaded with the verb 'Show' and enumerates the exact metadata returned. It is concise, with no redundant or vague phrasing.

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?

For a simple describe tool with two parameters and no output schema, the description adequately covers the purpose and the content of the output. It could add notes on prerequisites or error behavior, but given the tool's simplicity and clarity, it is largely complete.

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?

The input schema already describes both parameters (table and schema) with 100% coverage. The description does not add further semantics about the parameters, but it does clarify their purpose in the operation. This meets the baseline for schema-sufficiently-covered 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 what the tool does: it shows columns, types, primary keys, foreign keys, and indexes for a table. The verb 'Show' and the specific resource 'table' make the purpose unmistakable and distinguish it from siblings like list_tables and query.

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 is given on when to use this tool versus alternatives, but the description implies its use for inspecting table structure. It does not mention list_tables for discovering tables or query for data retrieval, leaving usage somewhat implicit.

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