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

Annotations already declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds valuable behavior: it notes that raw.githubusercontent.com URLs work, that 'text' format returns raw content for files, and that JSON is machine-readable. It does not mention error handling or rate limits, but the openWorld hint already sets expectations. The description enhances the annotation context without contradicting it.

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 dense paragraph packed with specific, actionable patterns. Every clause after the semicolons adds a new supported URL type or nuance. It is front-loaded with the primary purpose and avoids filler or repetition. The length is justified by the tool's breadth; each pattern 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 tool with many URL variants, the description is remarkably complete: it covers repository metadata+README, PRs, issues, discussions, files, trees, commits, history, branches, releases, and topics. It also explains format output differences. Since there is no output schema, the description provides all needed operational detail. Pagination behavior is not explicitly tied to endpoints, but the schema defines page/per_page, which is sufficient.

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 the schema already documents all four parameters. The 'ref' parameter description in the schema repeats the same detailed URL patterns as the main description, adding no new semantic value. The main description does not explain pagination or output format details beyond what the schema provides. Since the schema carries the load, baseline 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 opens with a clear verb-resource pair: 'Fetch GitHub data from a single ref.' It then enumerates the exact URL patterns and what each returns, making the tool's purpose unmistakable. It naturally distinguishes from sibling glim_github_search by focusing on fetching specific refs rather than searching.

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 clearly implies usage: use this when you have a specific GitHub URL or owner/repo shorthand. It enumerates the supported URL types, which is strong contextual guidance. It does not explicitly name alternatives or exclusions, but the get-versus-search distinction is obvious from the sibling tool names and the scope described.

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