dns_records

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

Goes well beyond the annotations by disclosing the approval gate, the environment-variable escape hatch, and that delete is permanent — real operational context an agent cannot get from destructiveHint alone. It stops short of explaining `dry_run`, which is the obvious safeguard for those destructive actions.

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?

Four short sentences, front-loaded with the read-only vs. mutating split, then per-action requirements. No filler or restatement of the title.

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?

Output schema exists, so return values need not be described, and the safety/approval story is fully covered. Gaps remain around pagination (page/limit), whether zone_id is required for scoped actions, and what dry_run does.

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 0% across 11 parameters, so the description must carry the burden; it partially does, mapping name/record_type/content to create and record_id to update. It says nothing about zone_id, ttl, proxied, page/limit pagination, or dry_run, leaving over half the parameters unexplained.

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?

Names the resource (DNS records) and enumerates every action the single `action` enum supports, so an agent knows this is a multi-op CRUD tool for individual records. It does not explicitly contrast with the sibling `dns_zones` (which handles the parent zones), leaving that distinction to inference from the name.

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?

Gives per-action guidance: list/get are read-only, create/update/delete mutate the zone and require approval or HOMELAB_DNS_ALLOW_WRITES=true. That is concrete when-to-use context, but there is no routing guidance toward alternatives such as `dns_zones` or `expose_service`.

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