ai.explain_repo

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

With no annotations provided, the description carries the full burden. It explicitly states the data sources (README and top-level file tree) and the nature of the output (an onboarding brief). 'Generate' implies a non-destructive read-only operation, giving sufficient transparency for an AI agent. It lacks explicit auth or rate-limit caveats, but these are not central for a generation tool.

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, focused sentence that conveys all necessary information without fluff. Every word earns its place, making it easy to parse and act upon.

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 simple input schema (owner/repo) and the presence of an output schema, the description is complete. It explains what the tool does, from what inputs, and the output type. No additional context about return values is needed since an output schema exists. The tool's scope is fully clarified.

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?

Schema description coverage is 0%, so the description must compensate. It does not explicitly describe the owner and repo parameters, but their names are self-explanatory within the GitHub context. The description's mention of 'repository' indirectly anchors the parameters, but it could be more explicit about how owner and repo identify the target. This is adequate but not outstanding.

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 generates an onboarding brief for a repository using its README and top-level file tree. The verb 'Generate' is specific, and the resource ('repository') is clearly defined. It differentiates itself from sibling tools like github.get_repo and ai.summarize_pr by focusing on newcomer onboarding.

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 phrase 'newcomer's onboarding brief' provides clear context for when to use this tool—when introducing someone to a repository. While it doesn't explicitly mention alternatives or exclusions, the use case is well-understood and distinct from siblings like code search or PR review.

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