List topics
list_topicsList popular topic tags with document counts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No |
list_topicsList popular topic tags with document counts.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already establish that this is a read-only, idempotent, non-destructive, closed-world operation. The description adds that the topics are 'popular' and include document counts, which is useful context beyond the annotations, but it does not disclose ordering criteria or limitations.
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 a single concise sentence with the core purpose front-loaded. It contains no wasted text, though it could be slightly more structured by mentioning the parameter behavior.
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 simple read-only listing tool with annotations covering safety and no output schema, the description provides a basic summary including document counts. However, it omits important details about the limit parameter, result ordering, and what 'popular' means, leaving meaningful gaps.
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 only parameter is 'limit,' and the schema description coverage is 0%. The description does not mention the limit parameter, its default of 50, or its range of 1-100, so it fails to compensate for the missing schema descriptions.
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 uses a specific verb and resource: 'List popular topic tags with document counts.' It clearly distinguishes the tool as a topic-listing operation rather than a document or comment operation, though it does not explicitly name a sibling alternative.
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?
The description gives no explicit guidance on when to use this tool versus alternatives such as search_documents. Usage is only implied by the phrase 'popular topic tags,' leaving the agent to infer the discovery/browsing context.
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.