whm_get_dns_zoneRetrieve a DNS zone's records and current serial before editing. Pass the returned serial and line indexes to the DNS zone edit operation to change records.
Get a zone's records and current serial. To change the zone, pass this serial and these line_index values to whm_edit_dns_zone.
| Name | Required | Description | Default |
|---|---|---|---|
| zone | Yes | The zone name, such as example.co.uk. |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is fully covered. The description adds the useful fact that the response carries a serial and per-record line_index values that are prerequisites for the edit tool, but says nothing about record volume, pagination, or whether the zone must already exist.
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, zero filler, with the primary purpose front-loaded and the downstream action placed second. Every clause carries operative information.
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?
With one required parameter, full schema coverage and no output schema, the description supplies enough: what is returned and how the result feeds the edit tool. A brief note on missing-zone behavior or record volume would close the remaining gap.
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% and the single 'zone' parameter is documented with format and an example, so the schema does the heavy lifting. The description adds no additional meaning about the zone parameter (e.g., whether an ID, domain, or subdomain is accepted), so the baseline 3 applies.
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?
States a specific verb and resource ('Get a zone's records and current serial'), which tells an agent exactly what comes back. It does not explicitly contrast with the sibling whm_list_dns_zones, leaving the get-one-vs-list-many distinction to be inferred from the names.
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?
Provides clear forward guidance: read here first, then hand the serial and line_index values to whm_edit_dns_zone to modify. It gives no exclusion against whm_list_dns_zones or whm_get_account, but the read-then-edit workflow is stated concretely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.