pve_task_log

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

No annotations, so description carries full burden. States read-only, paginated, and returns log lines with line numbers. Does not mention authorization needs or error cases, but is transparent about core 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?

Two concise sentences with no filler. First sentence states core purpose and read-only nature; second sentence adds pagination and sibling references. Extremely efficient.

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?

Has output schema, so return details are captured. Covers key use case, pagination, and references to related tools. Could mention potential errors (e.g., invalid UPID) but overall complete for a read-only log 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% and descriptions are detailed. The tool description adds minimal extra meaning beyond repeating schema info (e.g., pagination via start/limit). Baseline 3 is appropriate.

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?

Explicitly states 'retrieve a task's log output by UPID (read-only)' with specific verb and resource. Clearly distinguishes from sibling tools pve_task_wait and pve_tasks_list.

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 explicit alternatives: 'Use pve_task_wait for completion polling, or pve_tasks_list to find a UPID.' Lacks explicit when-not-to-use, but the referral to siblings gives clear context.

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