Unregister GitHub Actions Workflow

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

Annotations already flag the tool as destructive, and the description adds that it also removes stored check history, providing useful scope beyond the annotations. It does not mention reversibility or prerequisites, but the destructiveHint annotation covers the primary safety signal.

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 a single sentence that is front-loaded with the action verb and contains no superfluous words. Every word contributes to understanding the tool's behavior.

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 one-parameter destructive tool, the description covers the core purpose and extra behavior (check history removal), but it omits parameter semantics and any note about expected outcomes or error behavior. With no output schema, some return-value context would improve completeness.

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?

The input schema has one required parameter 'name' with 0% description coverage, and the description does not explain what 'name' refers to or provide any parameter guidance. The agent must infer from context, which is a significant gap for a tool with a single required parameter.

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 states a specific verb ('Remove') and resource ('GitHub Actions workflow target'), and also notes the removal of stored check history. This distinguishes it from sibling unregister tools like unregister_gitlab_pipeline and unregister_http_target, making the purpose unambiguous.

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 implies usage (when you want to remove a GitHub Actions workflow) but does not explicitly provide when-to-use vs alternatives or exclusions. The sibling list shows similar tools for other target types, but no alternative is referenced in the description.

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