getIssueJournal

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

Annotations already cover read-only, idempotent, and non-destructive behavior. The description adds valuable context beyond those by disclosing the 'without response compression' behavior and explaining that getIssue may return dropped or shortened journals that this tool retrieves in full.

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 tight sentences: the first states the tool's core behavior and key distinction, the second gives the precise usage condition. Every word contributes value, and the most important information is front-loaded.

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?

For a simple two-parameter read-only tool with an output schema and rich annotations, the description is complete. It tells the agent what the tool does, when to use it, and where the required IDs come from, with no meaningful gaps.

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 only 50%, with journalId already documented as coming from getIssue journals. The description adds some context for issueId by implying it comes from the getIssue result, but it does not fully explain the relationship or format beyond what can be inferred from the tool name and 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?

The description opens with a specific verb and resource: 'Retrieve one known issue journal entry in full'. It also distinguishes itself from the related getIssue tool by addressing the compression behavior and journal ID requirement, making the tool's purpose unambiguous.

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 this tool: 'Use after getIssue when its compression notes report a dropped or shortened journal'. This provides a clear condition and workflow context, leaving no ambiguity about how it relates to getIssue.

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