github_get_readme

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It discloses caching (ETag, 24h TTL), semantic distillation, and context budget controls. However, it does not explicitly state that the operation is read-only, nor does it mention auth requirements, rate limits, or error behavior. The disclosed behaviors are useful but incomplete for a tool with zero annotation coverage.

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 sentence that front-loads the core action ('Fetch the README markdown') and then lists the key features. No filler or redundant phrasing. Every word 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?

Given 100% schema coverage and no output schema, the description does not need to detail return format. However, for a tool with no annotations, it lacks critical usage context: it does not mention that this is a single-repo fetch versus batch, any prerequisites (e.g., repo must exist), or error handling. The description is functional but leaves the agent to infer when to use it relative to siblings.

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 coverage is 100%, so parameters are already documented. The description adds meaning by introducing 'semantic distillation' (mapping to the distill parameter) and 'context budget controls' (mapping to profile and max_chars), which help an agent understand the intended effect of these parameters beyond their raw schema definitions.

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 clear verb 'Fetch' and resource 'README markdown for a repository'. It's specific and unambiguous, but it does not explicitly differentiate from the sibling tool github_batch_get_starred_with_readme, which likely performs a similar fetch in bulk. The purpose is clear but sibling distinction is left to inference.

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 provides no explicit guidance on when to use this tool versus alternatives. It mentions caching and distillation, but does not state when to prefer this over batch tools or other retrieval methods. No when-not-to-use conditions are given.

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