inspect_repository

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

No annotations are provided, so the description must convey behavioral traits. It indicates 'public metadata', implying a read-only operation, but does not disclose error behavior, rate limits, or what happens if the repository does not exist. It also doesn't clarify what 'detected license' means or how detection works, leaving uncertainty for the agent.

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, well-structured sentence that directly states the tool's purpose and input format. There is no filler or repetition, making it highly concise and easy to parse quickly.

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 tool with one parameter and no output schema, the description covers the essentials: what the tool returns (public metadata and license) and the input format. It could be improved by mentioning the read-only nature or typical use cases, but given the simplicity, it is reasonably complete.

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 has 0% description coverage, but the description mentions 'Accepts owner/name', which clarifies the expected format for the repository parameter. This adds meaning beyond the schema's regex pattern. However, it doesn't explain the exact pattern or edge cases (e.g., leading/trailing whitespace), so it partially compensates.

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's function: inspecting a GitHub repository's public metadata and detected license. The verb 'inspect' is specific, and the resource (GitHub repository) is explicit, distinguishing it from sibling tools like check_license that focus solely on license checking.

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 when to use it (when you need repository metadata and license) but does not explicitly discuss alternatives or exclusions. With sibling tools like check_license available, explicit guidance on choosing between them would be beneficial, but the context is clear enough for a basic use case.

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