edit_dns_record

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

With no annotations provided, the description carries the behavioral burden. It explicitly states the full-replace nature and the requirement for 'reason', which is critical for an agent to avoid data loss. However, it does not mention error handling, idempotency, or missing field behavior.

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 extremely concise: three sentences that front-load the purpose, then add the critical full-replace behavior and the requirement for 'reason'. No extraneous 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?

Given 9 parameters, no output schema, and no annotations, the description is far from complete. It omits return value description, error conditions, preconditions, and does not clarify the meaning of 'content' or other fields. The complexity demands more detail.

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 input schema has 9 parameters with 0% description coverage, so the description must compensate. It only mentions that 'reason' is required and that all fields must be passed (full replace). It does not explain key fields like 'type', 'name', 'content', 'ttl', 'prio', or 'notes', leaving the agent with insufficient guidance.

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 edits an existing DNS record using Porkbun's record id, with the specific verb 'edit' and resource 'DNS record'. It also explains the full-replace behavior, distinguishing it from other tools like 'edit_dns_records_by_name_type' or 'delete_dns_record'.

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 notes that the edit is a full replace and that 'reason' is required, giving some usage context. However, it does not explicitly state when to prefer this tool over alternatives like 'edit_dns_records_by_name_type' or what prerequisites are needed (e.g., the record must exist).

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