sql_format
Format SQL text (never executed; reindent + keyword case).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | ||
| reindent | No | ||
| keyword_case | No | upper |
Format SQL text (never executed; reindent + keyword case).
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | ||
| reindent | No | ||
| keyword_case | No | upper |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
States 'never executed' (safety) and lists two specific behaviors (reindent, keyword case). Without annotations, this provides adequate transparency beyond the schema.
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?
Single sentence, front-loaded with purpose. Every word adds value, no redundancy.
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?
Tool has low complexity (3 params, no output schema). Covers core functionality and safety, but lacks a description of the return value (formatted SQL).
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 the description mentions 'reindent + keyword case', which maps to parameters. However, it does not explain the effect of boolean or enum values, nor explicitly names the 'text' parameter.
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 'Format SQL text' with a specific verb and resource, clearly distinguishing it from siblings (e.g., sql_danger_scan, sql_tables_extract) by adding 'never executed' and listing 'reindent + keyword case'.
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 on when to use vs alternatives. Usage is implied for SQL formatting, but no when-not-to or exclusionary hints are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.