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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds meaningful behavior: rendering happens server-side with nothing installed locally, permission to see the issue/page is sufficient, and the response includes the PDF's page count plus a 'quote' Markdown string. It does not cover failure modes or rate limits, but exceeds the annotation baseline.

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 dense paragraph that front-loads purpose before moving into usage, identification, parameters, and return details. Every sentence contributes useful information, though the density makes it slightly harder to scan than a structured list would be.

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 an 8-parameter read-only tool with no output schema, the description covers enough for correct invocation: purpose, when to use, how to identify the issue/wiki page and file, page numbering, box semantics, permission requirements, and the returned quote markdown. The image return is implied clearly enough, and no critical invocation detail is missing.

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 100%, so baseline is 3. The description adds real semantics beyond the schema: it explains the alternative identification paths ('key' vs 'pageId' vs 'spaceKey' + 'title'), clarifies that 'page' counts from 1, and gives concrete box syntax with an example ('0,0,1,0.5' is the top half). Width is left to the schema, which is fine given full coverage.

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 resource (a page of a PDF attached to an issue or wiki page) and operation (rendered as a viewable picture, optionally cropped). It distinguishes this tool from text-extraction tools by saying to use it for content that extracted text loses, such as superscripts, formulas, tables, and diagrams.

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?

It gives a clear usage context: read what a PDF's extracted text loses. It also references get_issue / get_wiki_page as the source for filenames and explains how to identify the containing issue or wiki page. It does not explicitly name a sibling alternative to use instead when text extraction suffices, so it stops short of full when-not guidance.

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