pve_sdn_dns_get

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

With no annotations provided, the description carries the full burden. It discloses that the return shape is an undocumented object, that secrets may or may not be echoed back, and that redaction only happens in update/delete plan previews and audit ledgers. This is transparent about the behavior beyond basic annotations.

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 a front-loaded 'READ-ONLY' label. Two sentences that provide essential information without wasted words. Every sentence serves a purpose.

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 that an output schema exists, the description need not explain return values. It covers the secret behavior and return shape. It does not mention broader context like SDN or DNS integration details, but it is sufficient for a focused read tool. Could add idempotency, but read-only implies it.

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%, so baseline is 3. The description does not add new meaning beyond what the schema provides; it mentions the dns parameter implicitly but schema already describes it fully. No additional elaboration on parameters.

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 explicitly starts with 'READ-ONLY: read one SDN dns integration's configuration.' This clearly specifies the verb (read) and resource (SDN DNS integration). It also distinguishes itself from siblings by noting that secret redaction only occurs in update/delete tools, not here, which differentiates its purpose.

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 labels the tool as 'READ-ONLY', implying it is for reading configuration only, not modification. It contrasts with update/delete tools by mentioning secret handling differences. However, it does not explicitly list when to use or when not to use, or name alternatives like the list tool.

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