github_secret_scanning_update_alert

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

No annotations are present, so the description must fully explain behavior. It fails to disclose what fields can be modified (e.g., state, resolution), permission requirements, or side effects. The agent is left with minimal insight into the tool's effects.

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, which is concise. However, it is overly brief and omits critical information. It sacrifices completeness for brevity, which does not serve the agent well.

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?

The description is severely incomplete. It does not explain the expected body format, updateable fields, or the response. Given that the tool performs a mutation, this lack of context makes it difficult for an agent to use correctly.

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?

While the input schema has 100% coverage, the descriptions are trivial ('owner', 'repo', 'alert_number', 'Request body (JSON object)'). The 'body' parameter lacks any explanation of its structure or allowed fields. The description adds no meaningful semantics beyond the schema.

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 'Update a secret scanning alert' clearly conveys the action (update) and the resource (secret scanning alert). It is concise and distinguishes itself from sibling tools like 'get_alert' or 'list_alerts_for_repo'. However, it lacks specificity about what aspects can be updated.

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 usage guidelines are provided. The description does not indicate when to use this tool versus alternatives, nor does it mention prerequisites or exclusions. This forces the agent to infer context from the tool name alone.

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