EasyTopic: list Documentation project's page tree

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

No annotations provided; description discloses flattening, ordering, returned fields, and that only visible pages are included. No contradictions.

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, no redundancy. First covers purpose and output, second provides prerequisite guidance.

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 no output schema, description adequately explains output fields and ordering. Sufficient for agent to use correctly.

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?

Single parameter projectId: schema has 0% coverage, but description explains how to obtain it from another tool, adding context beyond parameter name.

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?

Description clearly states it lists every page in a documentation project, flattened and ordered. It distinguishes from sibling tools like easytopic_get_doc_page (content retrieval) and easytopic_list_doc_projects (project list).

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?

Explicitly tells when to use this vs easytopic_get_doc_page for content, and how to get projectId from easytopic_list_doc_projects. Also explains tree reconstruction using parentTopicId.

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