github_actions_review_custom_gates_for_run

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

With no annotations, the description must disclose behavioral traits. It only states 'review', which is ambiguous (read vs. write). The presence of a 'body' parameter implies a write operation, but no details on side effects, permissions, or return values are provided.

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 concise at one sentence, but it sacrifices essential details. It is front-loaded with purpose, but lacks structure or elaboration, making it minimally viable.

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?

Given the tool's complexity (review action with a body parameter) and no output schema, the description is incomplete. It does not specify the expected response, the body structure, or prerequisites, leaving the agent underinformed.

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 schema covers parameter names but the description adds no meaning. The 'body' parameter is described as 'Request body (JSON object)' with no further structure, leaving the agent unaware of required fields or format. The description should clarify what the body should contain.

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 the tool reviews custom deployment protection rules for a workflow run, using a specific verb and resource. However, it does not explicitly differentiate from siblings like 'review_pending_deployments_for_run' or 'get_pending_deployments_for_run'.

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?

No guidance is provided on when to use this tool versus similar alternatives, such as 'github_actions_get_pending_deployments_for_run' or 'github_actions_review_pending_deployments_for_run'. The single-sentence description lacks context for selection.

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