remove_issue_block

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

With no annotations provided, the description carries the burden of behavioral disclosure. It adds useful context by stating the return value (the blocker issue) and a common error condition (404 if dependencies are not enabled). It also mentions default behaviors for dep_owner/dep_repo, though not perfectly accurately.

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 three sentences long, front-loaded with the core operation, and each sentence provides distinct, non-redundant information: the action, default behavior, return value, and error condition. There is no fluff.

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 simple remove operation with no output schema, the description covers the essential aspects: purpose, parameter defaults, response, and a key failure mode. It is sufficiently complete for an agent to select and invoke the tool correctly, though a more precise statement about dep_owner/dep_repo defaults would improve it.

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 100%, so the schema already documents all parameters. The description adds a brief explanation of the relationship between `index` and `dep_index`, but it largely restates defaults already in the schema and even slightly misstates them ('same repo' vs separate owner/repo defaults). Thus, it adds little value beyond what the schema provides.

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 clearly identifies the action ('Remove a block') and specifies the exact relationship between `index` and `dep_index`. It distinguishes this tool from sibling tools like remove_issue_dependency by focusing on the 'blocks' relationship rather than the inverse dependency relationship.

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?

The description gives clear context for when to use the tool (to unblock an issue), but it does not explicitly mention alternatives or when not to use it. Sibling tools such as remove_issue_dependency are not referenced, so the guidance is implied rather than explicit.

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