Skip to main content
Glama

List topics

list_topics

Discover available Kafka topic names, enforced by the configured allowlist. Optionally include internal topics that start with underscore.

Instructions

List topic names. Topics outside the allowlist are filtered out.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeInternalNoInclude internal topics (starting with _)
Behavior3/5

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

Without annotations, the description carries the behavioral disclosure burden. It does reveal a meaningful behavior: allowlist filtering. However, it does not state whether the operation is read-only, what happens when includeInternal is false, or any return-level behavior beyond names. It adds some transparency but not rich context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, no filler, and the core purpose is front-loaded. Every word earns its place, and the allowlist note is a relevant scoping detail rather than noise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple list operation with one optional, fully documented parameter and no output schema, the description plus schema is largely sufficient. It tells the agent what output to expect (topic names) and what filtering applies. Minor missing context includes whether results are ordered or paginated, but these are not critical for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% for the single includeInternal parameter, so the schema already explains its meaning. The description does not need to add parameter detail, and it doesn't, which matches the baseline 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'List topic names.' It is immediately clear this is a read-only enumeration operation over topics, distinguishing it from siblings like describe_topic and topic_offsets without requiring schema inspection. The allowlist filtering clause adds precise scope.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage—use this when you want topic names within the allowlist—but provides no explicit when/when-not guidance or alternatives. It does not mention when to prefer describe_topic or other siblings, leaving the choice to inference.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/dockndevai/mcp-kafka'

If you have feedback or need assistance with the MCP directory API, please join our Discord server