List all Kafka topics and apply an optional regex pattern to filter and locate specific topics quickly.
List all Kafka topics. Optionally filter by pattern (regex).
| Name | Required | Description | Default |
|---|---|---|---|
| pattern | No | Optional regex pattern to filter topics (e.g., "order" to find order-related topics) |
Changes observed during successful MCP inspections.
v1.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must carry behavioral disclosure. It clearly signals a read-only listing operation via 'List' and describes optional regex filtering, but it does not address edge cases such as invalid regex, cluster scope, or whether internal/hidden topics are included.
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 with no filler; the core action and scope appear immediately, and the optional filter is stated efficiently.
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 tool with one optional parameter and no output schema, the description covers the essentials: what action is performed, on what resource, and how to filter. It could add expected return format, but 'List' makes the return of topic names self-evident.
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 schema already documents the optional pattern parameter fully. The description's reference to regex filtering is redundant with the schema and adds no new parameter semantics.
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 states a specific verb ('List') and resource ('Kafka topics'), and clarifies scope ('all') plus an optional regex filter. This differentiates it from sibling tools like kafka_describe_topic, kafka_read_messages, and kafka_consumer_groups, which target other Kafka resources.
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 implies the primary use case (enumerate topic names, optionally narrowed by regex) but does not explicitly mention when to prefer this over sibling tools, nor any exclusions or alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.