Export a DNS zone and all its records as a JSON migration bundle for transferring configurations between servers. Optionally include password hashes and secrets when needed.
Export a DNS zone with all its records as a migration bundle (JSON).
| Name | Required | Description | Default |
|---|---|---|---|
| zone_id | Yes | Zone ID to export | |
| include_secrets | No | Include password hashes and other secrets in the bundle (default false: redacted) |
Changes observed during successful MCP inspections.
v0.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the behavioral transparency burden. The word 'export' implies a non-mutating read operation, and the description usefully discloses the JSON bundle format and that all records are included. However, it does not explicitly state that the operation is read-only, describe how the bundle is delivered, or mention any permissions or size considerations.
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?
A single front-loaded sentence states the action, resource scope, and output format with no filler. Every word contributes to understanding what the tool does, making it a compact and effective definition.
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?
For a two-parameter export tool with full schema coverage and no output schema, the description adequately states what the bundle is and what it contains. It falls slightly short of full completeness by not explaining delivery mechanics or explicitly contrasting with dns_zone_get, but the migration label covers much of that context.
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 description coverage is 100%, with both zone_id and include_secrets clearly documented in the input schema. The description adds no parameter-level information, but that is acceptable because the schema already handles both parameters adequately, setting the baseline at 3.
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?
Description opens with a specific verb 'Export' and identifies the exact resource: 'a DNS zone with all its records as a migration bundle (JSON)'. This clearly differentiates the tool from sibling dns_zone_get and the other migrate_export_* tools, so an agent can understand the scope immediately.
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 phrase 'as a migration bundle' clearly signals this tool is intended for migration scenarios and helps distinguish it from ordinary DNS read tools like dns_zone_get. It does not explicitly list exclusions or alternative tools, but the migration-bundle framing provides a solid usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.