codex_collect_diagnostics

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

With no annotations, the description carries the burden. It states the tool collects diagnostic snapshots and does not execute repairs, implying it is a read-only operation. However, it does not explicitly state that it does not modify any state, leaving some ambiguity about potential side effects.

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 very concise, consisting of two sentences that state purpose and usage context without any wasted words. It is well-structured for quick reading.

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 the tool has 11 parameters with zero schema descriptions and no annotations, the description should provide more guidance on scoping and optional behavior. It only mentions 'scoped diagnostic snapshot' without explaining how to control scope via parameters, leaving significant gaps for correct invocation.

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%, so the description must compensate. It contains no information about any of the 11 parameters (e.g., operation_id, since_minutes, include_logs), leaving the agent without guidance on how to specify the scope or customize the diagnostic snapshot.

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 uses a specific verb 'Collect' and resource 'diagnostic snapshot', clearly stating the tool's purpose. However, it doesn't explicitly differentiate from sibling tools like 'codex_get_diagnostic_logs' or 'codex_health_summary', though the mention of 'compact evidence and guidance' hints at a distinct output.

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 explicitly states when to use ('before repair when status reports failed, stale, orphaned, or degraded state') and what the tool does not do ('does not execute repairs'). This provides clear context, but it does not mention alternative tools or when not to use it.

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