batch_link_to_project

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

Describes parallelism, required format for project_id, and the return structure (total, successful, failed, etc.). Lacks details on error handling or side effects, but overall transparent for a batch operation.

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?

Five short, focused sentences with no filler. Front-loaded purpose, then requirements, then return format. Each sentence adds value.

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?

Covers main purpose, key requirements, and return structure. Missing details on optional parameters (owner, repo, max_workers) and potential error scenarios, but overall adequate for a batch tool with output schema.

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 coverage is 0%, so description must compensate. Explains project_id format and lists required parameters but omits semantics for owner, repo, and max_workers. Return structure is useful context.

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 'Link multiple issues to a GitHub Project (v2) board in parallel.' It specifies the verb (Link), resource (issues to Project board), and parallelism, distinguishing it from sibling tools like batch_add_labels.

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?

Implied usage for batch-linking issues, but no explicit when-to-use or when-not-to-use vs alternatives. Mentions project_id format and required token scope, which is helpful for setup.

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