Journal Query Tool

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

There are no annotations, so the description carries the full behavioral burden. It only says 'Query' and does not explicitly state that this is a read-only operation, whether it can scan the whole system journal, or any resource/impact caveats. This is a notable gap for a diagnostic tool.

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 a single short sentence with the core action front-loaded. The '2AM' phrasing is informal but compact and quickly conveys the troubleshooting role.

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?

Parameter syntax and return shape are fully covered by the input and output schemas. The remaining gap is that the description does not provide behavioral guardrails or read-only assurance, which matters because there are no annotations.

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?

Input schema coverage is 100% with each of the 7 optional parameters having a type, default, and description. The description adds no parameter-level detail, but none is needed; the schema does the heavy lifting.

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 states a specific action and resource: 'Query the journal', and identifies it as the main troubleshooting tool. None of the sibling tools query logs, so an agent can immediately distinguish this from unit/job operations.

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 main 2AM troubleshooting tool' gives a clear context: use it when diagnosing problems via logs. It does not name exclusions or alternatives, but no other journal/log sibling exists, so the guidance is adequate.

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