db_setup_save

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

With no annotations, the description carries full burden. It states mutating nature and server-side password handling, but does not disclose what gets destroyed (e.g., potential overwrite of existing profiles) or other side effects.

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 core purpose and effect, followed by critical warning. Every sentence earns its place; no fluff.

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?

No output schema, and description does not specify return values (e.g., success message, error handling). With 9 parameters, it lacks detail on edge cases like overwrite behavior or error states.

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 100%, but description adds value: it clarifies that token is a staging token and password is never in context, and that label defaults to config-path derived value. This goes beyond parameter descriptions.

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 the tool's action: 'Commit a staged DB credential to the secret store and write a db_profile'. It specifies the verb 'Commit' and resource 'staged DB credential', and distinguishes from siblings like db_setup_scan and db_setup_remove.

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?

The description provides explicit instructions: 'The password is read from server-side staging by token — never from your context' and 'Mutating: confirm with the user first'. It also implies when to use (to enable db_processlist/db_top_queries), but no explicit exclusions or alternatives.

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