Repository

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

Annotations already declare readOnlyHint=false, openWorldHint=true, and idempotentHint=false. The description adds meaningful context beyond them: it consumes paid API credits, requires confirm=true, and clarifies the read-like POST does not publish to social platforms. This credit/cost disclosure is genuinely useful.

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?

Front-loaded with the core purpose and returned fields, then the URL instruction, then cost/permission notes. Efficient and well-ordered, with no filler, though the final sentence is slightly tangential.

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 tool with no output schema, listing returned fields is a helpful completeness measure, and cost + confirm requirements are disclosed. An agent has what it needs to invoke it correctly; only the absent sibling routing keeps it short of full marks.

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 100%, so all three parameters (url, account, confirm) are already documented in the schema. The description only nudges the url format ('full GitHub repository url'), adding marginal value over what the schema provides — baseline 3.

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?

States a specific verb (Retrieves) and resource (public metadata for one GitHub repository), and enumerates the returned fields (owner, stars, forks, license, etc.). The singular 'one repository' distinguishes it clearly from the sibling github_repositories list tool.

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?

Provides one actionable instruction ('Pass a full GitHub repository url') and implies single-repo scope, but never names the alternative (github_repositories, github_user) or states when-not to use it. Usage is implied rather than explicit.

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