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

Description implies read-only operation ('look up') and repo restrictions. Annotations confirm readOnlyHint, idempotentHint, and destructiveHint, with no contradictions. Adds repo scope beyond annotations.

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?

Single sentence, front-loaded with purpose, no extraneous words.

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?

Simple lookup tool with no output schema; description adequately covers purpose, parameters, and scope. Return values are implied as standard GitHub issue/PR data.

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 has 100% coverage with descriptions; description adds clarity on repo shorthand format (e.g., 'canton-dev-fund'). Number parameter is straightforward; no additional detail needed.

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?

Description clearly states verb 'look up', resource 'GitHub issue or PR', and key constraints (by repo+number, limited to Canton/Daml/Splice repos). Distinguishes from sibling tools like search_github_issues.

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?

Explicitly restricts to specific repos ('Canton/Daml/Splice repos only'), which guides appropriate usage. No explicit alternatives mentioned, but scope is clear.

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