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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the bar is low, but the description still adds meaningful behavior: counts are scoped to 'this week', implying a rolling weekly snapshot rather than an all-time total. It also names the returned fields, which helps even though an output schema exists.

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 sentences, zero padding: the first defines the resource and its payload, the second states the downstream use. The most important fact (what this tool returns) is front-loaded.

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?

No required parameters, full schema coverage, an output schema for return values, and rich annotations leave little for the description to carry. What it does carry — the resource identity, the weekly count scoping, and the slug handoff — is exactly what structured fields cannot express.

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 the compact/verbose and English/French parameters are already documented and a baseline of 3 applies. The description goes beyond that by explaining the functional role of the slug output — that it is the key consumed by topic_ranking and emerging — which the schema cannot convey.

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 gives a specific verb and resource ('Lists the topics Upstar ranks GitHub repositories in') and immediately grounds it with examples plus the exact fields returned (category, name, category, description, repository counts). A reader can distinguish it from sibling list tools like list_collections or get_repo without opening a 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 states a concrete follow-up path: 'Use a slug with topic_ranking or emerging,' which tells the agent this tool is the discovery step for two specific siblings. It does not explain when to prefer it over list_collections or when the listing is unnecessary, so it stops short of full when/when-not guidance.

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