Lists all document pages currently indexed to reveal documentation coverage, enumerate available topics, or verify whether a subject is included.
列出当前索引收录的全部文档页面。
何时使用：需要了解文档覆盖范围、列举全部页面，或确认某主题是否被收录。 何时不使用：已有明确查询词时，用 search_docs 更合适。 返回：JSON，含 count 与 pages（每项含 title）。索引初始化中或刷新失败时返回 status 字段；后台刷新进行中时额外带 refreshing 字段。
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full responsibility. It discloses the return structure (count, pages with titles) and edge-case behavior around status and refreshing fields during index initialization or background refresh, which is valuable behavioral context.
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 compact and well-organized: purpose first, then usage guidance, then return details. Every sentence adds value without redundancy.
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 parameterless listing tool, the description fully covers purpose, usage, return format, and special status conditions. It is complete in context with sibling tools and output schema.
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?
The tool has zero parameters, so the baseline is 4. No parameter documentation is needed, and the description focuses appropriately on behavior and return values.
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 the tool lists all document pages in the current index, with a specific verb and resource. It distinguishes itself from siblings by contrasting with search_docs for query-based retrieval and get_page for individual pages.
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?
Provides explicit when-to-use guidance: when needing document coverage, enumerating all pages, or checking topic inclusion. Also explicitly says when not to use it and directs to search_docs instead.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.