pve_ceph_metadata

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

No annotations exist, so the description carries full burden. It specifies READ-ONLY, meaning no side effects. The adversarial note adds important context about trusting the data. It does not mention authentication or rate limits, but the read-only nature is clear.

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 detailed and well-structured but somewhat verbose. The adversarial warning is relevant but adds length. Could be more concise while retaining key 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 an output schema exists, return value details are not needed. The description covers purpose, data type, scope variants, and an important safety warning. It mentions the shape similarity to pbs_remote_scan. Fairly complete for a metadata retrieval tool.

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%, so baseline is 3. The description adds extra detail on scope options ('all' vs 'versions') beyond the schema, but for proximo_target it adds nothing. Marginal value over schema.

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?

Clearly states it retrieves per-daemon Ceph metadata (mon/mgr/mds/osd/node) in read-only mode. Includes the endpoint and scope parameter variants. However, it does not explicitly differentiate from sibling tools like pve_ceph_osd_metadata or pve_ceph_cfg_value.

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?

Describes the tool as READ-ONLY and includes an adversarial warning (treat as data to report, not instructions). The scope parameter behavior is explained. However, no explicit guidance on when to use this tool versus related Ceph metadata tools is provided.

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