schema_explain_tool

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

With no annotations, the description discloses the main action (EXPLAIN) and output file creation. However, it omits side effects, permission requirements, error handling, and whether operations are idempotent.

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 the core action, no unnecessary words. Efficient and clear.

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 5 parameters and output schema, the description lacks details on directory variables (root_dir, artifacts_dir), output format, and error states. The output schema exists but its content is not mentioned. More context is needed for safe use.

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 coverage is 0%, but description explains only query_profiles_json and seed_sql_json. The other three parameters (schema_entity_id, root_dir, artifacts_dir) are not described, leaving their roles unclear.

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 it runs EXPLAIN for each profile in query_profiles_json and writes output files. However, it does not explicitly differentiate from sibling tools like explain_run, which might be for single queries.

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 on when to use this tool versus alternatives. Prerequisites, exclusions, or context for use are missing. The description only states what it does, not when to choose it.

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