github_list_code_scanning_alerts

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

No annotations are provided, so the description must fully disclose behavioral traits. It fails to state whether the operation is read-only, requires specific permissions, has rate limits, pagination, or any details about side effects or response behavior. The only behavioral info is the routing path, which is insufficient.

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 two sentences long, but the first sentence merely restates the tool name and the second provides routing details. It is concise but could be restructured to front-load actionable information.

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 lack of annotations, incomplete parameter documentation, and missing output description (despite an output schema existing), the description leaves significant gaps. An agent cannot determine what alerts are returned, how to filter, or how to interpret results.

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 a single 'arguments' parameter with 0% description coverage. The description adds 'JSON string of arguments for the connector operation' but does not specify expected keys, format, or examples. This adds minimal value beyond the schema field name.

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 states it is a Github connector operation to list code scanning alerts, which clearly identifies the action and resource. However, it does not differentiate from sibling tools like github_list_secret_scanning_alerts or provide context on what code scanning alerts are. The purpose is clear but lacks functional distinction.

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 alternatives (e.g., list_secret_scanning_alerts, list_dependabot_alerts). There is no mention of prerequisites, context, or exclusion criteria, leaving the agent without decision support for tool selection.

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