inspect_github_project

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

With no annotations provided, the description carries the full behavioral disclosure burden. It discloses that the tool inspects rather than mutates, returns exact commit and project evidence, and returns unsupported for unprofiled repositories. This is meaningful behavioral context, though it does not detail output structure, authentication, or rate limitations.

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 with no filler. The primary action and output are front-loaded, and the exception condition is stated succinctly in the second sentence. Every sentence earns its place.

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 single-parameter tool with no output schema, the description adequately covers what the tool does, what it returns, and when it will not work. It could be slightly more explicit about the exact shape of the evidence, but overall it is sufficient for an agent to decide whether to invoke 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?

The schema already fully documents the single parameter repo_url as 'Public GitHub repository URL' (100% coverage). The description adds context about profiling and allow-listing but does not add further parameter-level meaning, so the baseline score of 3 is appropriate.

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 a specific action ('Inspect') on a specific resource ('profiled, allow-listed public GitHub repository') and clearly defines the output ('exact commit and project evidence'). This distinguishes it from the sibling tools like reproduce_python_project and rescue_python_snippet, which have different purposes.

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 the tool applies: only profiled, allow-listed repositories. It also notes the failure mode for repositories without an explicit verification profile, which is a useful exclusion cue. However, it does not explicitly name alternative tools or provide when-not-to-use guidance beyond this precondition.

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