sqlbot_describe_table

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

No annotations are provided, so the description must fully disclose behavioral traits. It does not mention that the tool is read-only, the nature of the result, or any side effects. The only clue is 'Describe checked fields', which is insufficient.

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 sentence, which is concise, but it does not make efficient use of that brevity. It could be restructured to include more context without becoming verbose.

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?

With no output schema and 4 parameters (2 required), the description lacks critical context about what the tool returns. The phrase 'Describe checked fields' is ambiguous; it does not specify the format or extent of information provided.

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 provides descriptions for all 4 parameters (100% coverage), so the description adds no additional meaning. The tool name and description already imply the role of `table_name` and `datasource_id`, but the optional `access_key` and `secret_key` are not elaborated beyond their schema defaults.

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 uses a specific verb ('Describe') and resource ('checked fields for a SQLBot metadata table'), which distinguishes it from sibling tools like sqlbot_list_tables. However, it is somewhat vague as it does not clarify what 'checked fields' means or how it differs from listing 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?

No guidance is provided on when to use this tool versus alternatives such as sqlbot_ask_data or sqlbot_generate_report. The description does not indicate prerequisites or non-applicable scenarios.

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