fetchGithubReadme

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds the URL scope restriction but doesn't disclose further behavioral details such as response format or potential rate limiting. With annotations carrying the safety burden, a 3 is appropriate.

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?

A single sentence with zero waste. The main action is front-loaded, followed by the URL restriction and the alternative tool, all in one breath.

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 one-parameter fetch tool with annotations covering safety, the description is fully adequate. It states the input scope, the output concept (README content), and routes other URLs elsewhere. No output schema is needed for such a simple read operation.

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 by clarifying the url parameter must be a GitHub or Gitee repository URL, which is essential meaning beyond the bare 'url' property name. It could be more precise (e.g., full format https://github.com/owner/repo), but it provides sufficient guidance for correct invocation.

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 names a specific verb and resource: 'Fetch README content from a GitHub/Gitee repository URL'. It also distinguishes itself from the sibling fetchWebContent by explicitly restricting input to github.com/gitee.com repo URLs, so an agent can tell them apart without opening the 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?

It explicitly states when to use the tool ('github.com or gitee.com repo URLs only') and provides the alternative for other cases ('for other pages use fetchWebContent'). This gives clear routing with no ambiguity.

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