docs-mcp

List Config Properties

list_config_properties

Read-only

Search Redpanda configuration properties by a keyword in their name or description, and filter by scope (cluster, broker, topic), platform, or enterprise flag. Returns compact rows: name, scope, type, default, one-line summary, Cloud support, docs URL. Name matches rank above description matches; deprecated properties are hidden unless include_deprecated is true. Use it to find the right property name before get_config_property, or to answer 'which properties control X'. total=0 means nothing matches in that version; it never falls back to a guess.

Input Schema

Name	Required	Description
`limit`	No	Maximum rows to return (default 25, max 100).
`query`	No	Keyword matched against property names and descriptions, e.g. 'retention' or 'tls'. Omit to list by filter only.
`scope`	No	Only properties of this scope.
`context`	No	Optional. In one concise sentence (third person), describe what the user is trying to accomplish with this request. Do not include credentials, tokens, personal data, or verbatim secrets.
`version`	No	Docs version as its URL spells it ('26.1'), 'current' for the latest release, or a release tag ('v26.2.4'). Omit for the latest release. An unknown value returns found=false with the list of published versions. Ignored when platform is 'cloud', which always answers from the latest release.
`platform`	No	'cloud' answers for Redpanda Cloud (Cloud availability, the Cloud docs page); 'self-managed' (the default) answers for Self-Managed Redpanda.
`enterprise`	No	true: only enterprise-licensed properties; false: only non-enterprise.
`session_goal`	No	Optional. In one concise sentence (third person), the overall goal of this session: what the user is trying to get done, not just this call. Send the same goal on every call in the session, and update it only if the goal changes. Do not include credentials, tokens, personal data, or verbatim secrets.
`include_deprecated`	No	Include deprecated properties (default false).

Output Schema

Name	Required	Description
`note`	No
`error`	No	Set when the call was not answered: 'anonymous_quota_exhausted' or 'data_unavailable'.
`limit`	No	Quota refusal only.
`total`	No	Matches before the limit. Absent only when `error` is set.
`reason`	No
`dataset`	No
`message`	No
`returned`	No
`resets_at`	No	Quota refusal only.
`properties`	No
`sign_in_url`	No	Quota refusal only.
`valid_versions`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedOct 26, 2026

addedInput schema / properties / session_goal

Added value: +{
+  "description": "Optional. In one concise sentence (third person), the overall goal of this session: what the user is trying to get done, not just this call. Send the same goal on every call in the session, and update it only if the goal changes. Do not include credentials, tokens, personal data, or verbatim secrets.",
+  "type": "string"
+}

AddedOct 26, 2026

TDQS

A4.7/5.0

Behavior4/5

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

Annotations already declare readOnly/non-destructive, but the description adds real behavioral context beyond them: name matches rank above description matches, deprecated properties are hidden by default, and total=0 explicitly means no match with no fallback guess. It does not mention limit or pagination behavior, but the schema covers that.

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?

Roughly five sentences, each carrying distinct information (purpose, return shape, ranking rule, deprecation default, routing to sibling, empty-result semantics) with purpose front-loaded. Nothing repeats structured fields verbatim.

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 9-parameter read-only search tool with an output schema and full schema coverage, the description covers purpose, result shape, ranking, default filtering, and the meaning of an empty result. An agent has everything needed to call it and interpret the outcome correctly.

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; the description still adds meaning by explaining that the keyword matches both names and descriptions, that scope/platform/enterprise act as filters, and that include_deprecated changes result visibility. It does not add syntax detail for version beyond what the schema already says.

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 ('Search Redpanda configuration properties') plus the matching axes (keyword in name or description, filters by scope/platform/enterprise). It is clearly distinguishable from the sibling get_config_property, which fetches a single property by name.

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

Usage Guidelines5/5

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

Explicitly routes the agent: 'Use it to find the right property name before get_config_property, or to answer which properties control X.' Names the alternative and the condition that selects it, and no hidden exclusions are left to inference.

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

All docs-mcp tools Inspect

Try in Browser

Shareable, User-Owned Context BackendPeople, applications, and agents read, write, and coordinate together in one context lake. Reach it over MCP, a CLI, a Python SDK, or REST.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.