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

Annotations only flag this as a non-read-only, open-world, non-idempotent write. The description goes well beyond that by disclosing the linked-account requirement (spam guard), a concrete rate limit (10 calls/day per account), and a safety constraint (never include API keys or secrets). That is exactly the extra behavioral context annotations cannot carry.

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?

Purpose, target URL, and eligibility come first, followed by the requirements and constraints. The 'Welcome — we want agents to report problems instead of silently papering over them' clause is motivational filler, but the rest of the text is dense and earns its place.

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 fire-and-forget issue-filing tool with no output schema, the description supplies everything an agent needs: where the issue goes, what qualifies, the account requirement, the rate limit, and the no-secrets rule. Nothing material 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 both parameters are already documented, including 'Optional project id this report relates to.' The description's note that projectid is optional context and its secrets warning largely restate the schema, adding little new semantics. Baseline 3 applies.

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?

States a specific verb (file) plus the resource (GitHub issue) and the exact target URL, then scopes the content: generated/catalog code problems or component/docs change requests. No sibling tool does anything comparable, so an agent can select it unambiguously.

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?

Gives clear context for when to use it — reporting problems with generated or catalog code, or requesting component/docs changes — and frames the intent ('report problems instead of silently papering over them'). It stops short of naming when-not-to-use or an alternative channel, so it falls one step below the top.

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