Skip to main content
Glama

alter_topic_config

Change Kafka topic-level settings for 1 to 100 topics: set keys, delete overrides, and preview per-key current/requested values before applying with confirm.

Instructions

Change topic-level configuration of 1 to 100 topics in one call through items. Each item sets keys (set) and removes overrides so the cluster default applies again (delete). Every key not named keeps its value: changes are incremental, never a full replace. Changing one topic is an items array of length one.

No change is made unless confirm is true. The preview asks the broker to validate every item and returns, per key, the current value and its source (DYNAMIC_TOPIC_CONFIG means a deliberate topic setting; anything else is inherited) next to the requested value. Shortening retention.ms reports how many messages are already older than the new limit, because they become eligible for deletion straight away. Changing cleanup.policy or retention.bytes is warned about.

One confirm covers the whole batch, and applying is not atomic: topics changed before a later item failed stay changed. Results follow items order, each carrying index with result or error. Requires Kafka ALTER_CONFIGS permission.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsYesThe topics to change, 1 to 100 of them. Changing one topic is an array of length one. Duplicate topic names are refused before anything changes.
confirmNoOptional. When false or omitted, nothing is changed: the broker validates every item and the response shows each key's current and requested value. Must be true to apply. One confirm covers the whole batch.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
atomicYes
failedYes
appliedYes
resultsYes
succeededYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.6/5.0
Behavior5/5

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

No annotations exist, so the description carries the full burden and discharges it: incremental rather than full-replace semantics, non-atomic partial application ('topics changed before a later item failed stay changed'), duplicate rejection, the DYNAMIC_TOPIC_CONFIG source meaning, and the ALTER_CONFIGS permission requirement. These are exactly the caveats an agent cannot infer from the schema.

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

Conciseness4/5

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

Purpose is front-loaded in the first sentence and each subsequent sentence adds a distinct behavior (incremental, confirm gate, preview sources, warnings, non-atomicity, permission). It is dense prose rather than scannable bullets, which costs a point, but there is little wasted text.

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

Completeness5/5

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

For a batch mutation tool with no annotations, the description covers everything an agent needs: permission, confirmation semantics, atomicity, per-item result shape, and which keys trigger warnings. An output schema also exists, so the description's brief nod to result structure is sufficient rather than required.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning beyond the schema: set/delete mutual exclusivity is stated structurally, 'one confirm covers the whole batch', and results map back to items order via index. The set/delete field-level details in the schema are not repeated, which is appropriate.

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?

Opens with a specific verb+resource+scope: 'Change topic-level configuration of 1 to 100 topics in one call through items.' The qualifier 'topic-level' implicitly separates it from the cluster-level server_config sibling, and 'Every key not named keeps its value: changes are incremental' makes the modification model unambiguous.

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

Usage Guidelines4/5

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

Gives clear operating context: the confirm gate ('No change is made unless confirm is true'), the preview/validation flow, and explicit warnings for retention.ms, cleanup.policy, and retention.bytes. It never names an alternative tool (e.g. server_config vs topic config) or states when-not to use it, so it stops short of 5.

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