database_dump

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

With no annotations, the description discloses write behavior (creates root-owned file), the use of mysqldump, staging directory restriction, and required configuration. It also explains the dry_run and confirm parameters. Minor missing details like overwrite behavior but overall transparent.

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 concise with four sentences, front-loading the purpose. Every sentence adds value, no redundancy, and covers essential aspects.

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 no output schema, no annotations, and moderate schema coverage, the description provides sufficient context: operation, constraints, parameters, and required configuration. It explains what the tool returns (path and byte size) and how to use it safely.

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 description adds meaning beyond the schema for dry_run and confirm ('set dry_run:true to preview, confirm:true to execute') and explains output_path default. Schema coverage is 50%; the description compensates by clarifying boolean flag usage and output path formation.

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 'Dump a database to a .sql file ON the FastPanel host via SSH (mysqldump).' This provides a specific verb and resource, and distinguishes it from siblings like database_import or databases_list by detailing the operation and constraints.

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 includes when to use (dumping to a file), constraints (only local MySQL via root socket, rejected remote/non-MySQL), prerequisites (SSH configured), and guidance on dry_run and confirm flags. However, it does not explicitly mention alternatives among siblings, though the context is clear.

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