List topics
list_topicsEvery question topic the archive files passages under, with a summary and passage count.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
list_topicsEvery question topic the archive files passages under, with a summary and passage count.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered and the description need only add context. It does add the return shape (summary plus passage count), which is genuinely useful, but says nothing about ordering, completeness, or size limits for a full enumeration.
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 filler, front-loaded on what the tool returns. Every clause (topics, summary, passage count) carries distinct information.
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?
With no parameters, no output schema, and annotations covering the safety profile, the description's main remaining duty is to say what comes back, and it does so in outline form. A brief note on ordering or whether the list is truncated would close the only real gap.
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 takes zero parameters, so the baseline is 4; there is no parameter meaning for the description to supply. Schema coverage is reported at 100% for an empty object, so nothing is missing.
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 the resource ('every question topic the archive files passages under') and the payload ('a summary and passage count'), which is concrete enough to distinguish it from get_topic, the single-topic sibling. It never explicitly contrasts with get_topic, but 'every' plus the aggregate fields makes the enumeration role readable.
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?
Usage is only implied: an agent infers this is the entry point for discovering topics before calling get_topic or search_passages. There is no explicit when-to-use, no when-not-to-use, and no named alternative, even though the sibling set contains an obvious near-neighbor in get_topic.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.