Get Readme

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

With no annotations, the description carries the full burden and does deliver real behavioral context: output is sanitized against prompt injection, wrapped in <untrusted_content> tags, and has benchmark tables/YAML frontmatter stripped. What is missing is practical operational behavior such as error cases or whether the call is purely read-only/rate-limited.

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?

Two tight paragraphs with the core purpose front-loaded and the safety note clearly flagged. Every sentence carries information; only the 'IMPORTANT SAFETY' label adds slight verbosity over the content itself.

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?

An output schema exists, so return values need not be explained, and the description covers purpose, sources, sanitization, content filtering, and truncation. It stops short of covering failure modes or multi-source usage, but for a simple read tool this is close to 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?

Schema coverage is 100%, with all three parameters (source, id, max_chars) already documented including allowed source values and default. The description adds no parameter-level meaning beyond implying that truncation/omission occurs, so the baseline of 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?

States a specific verb (fetch and sanitize) plus a specific resource (documentation/README) and enumerates the exact source types it applies to (GitHub repo, Hugging Face model/Space). This is clearly distinguishable from siblings like get_repo_health or the search_* tools without needing to open any schema.

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 scope sentence implies when the tool applies (any time you need the docs for a given repo/model/space), but there is no explicit when-to-use/when-not-to-use guidance and no mention of alternatives such as compare_candidates for reading multiple sources. Usage is inferable rather than stated.

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