add_github_project_item

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

Annotations cover the safety profile (readOnly=false, idempotent=false, destructive=false, openWorld=true), so the bar is lower. The description adds genuine non-annotation context: the tool is disabled by default and requires an explicit Project allowlist, which is auth/availability information the agent cannot get elsewhere.

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 with the core action front-loaded and the gating constraint second; nothing is wasted, though it could carry one more clause of practical detail without becoming bloated.

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 mutation with no output schema and undocumented parameters, the definition covers the safety profile and the allowlist gate but omits param formats and any notion of the result (e.g., confirmation of the added item). Adequate but with clear 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 0%, so the description must compensate. It loosely maps the two params (contentId = an existing Issue or PR node, projectId = an authorized Project v2), but gives no format or syntax (node ID vs URL), leaving the agent to guess how to populate them.

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 uses a specific verb+resource ('Add an existing GitHub Issue or Pull Request node to an authorized Project v2'), making the operation clear and distinguishable from read siblings. It stops short of explicitly naming the closest alternatives (add_github_project_sub_issue, add_github_project_blocked_by), so an agent must infer the difference.

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?

'Disabled by default and requires an explicit Project allowlist' is a meaningful precondition, but it is an availability gate rather than when-to-use guidance. No sibling tool or alternative path is named, so the agent gets implied context only.

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