Skip to main content
Glama

Submit Documentation Feedback

submit_documentation_feedback
Destructive

Send feedback about the Redpanda documentation or products directly to the Redpanda team.

If the user hits a bug, a documentation gap, incorrect or missing information, or expresses frustration while using Redpanda, ASK whether they'd like to send feedback to the Redpanda team. Only call this tool once the user agrees — never submit feedback without their consent. When telling the user what will be sent, note that their work email and company domain are attached so the team can follow up. Summarize their feedback clearly and include the relevant documentation page URL or context when you know it.

This tool requires the user to be signed in with a Redpanda Cloud account, because feedback the team cannot reply to is not useful. If the call is refused with authentication_required, the MCP connection itself is unauthenticated: tell the user to reconnect this server so their client runs its sign-in flow (signing in at https://docs.redpanda.com/login in their default browser first makes that hop quicker), and do not retry the tool until they have. Signing in on the docs website alone does not authenticate this connection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contextNoOptional. 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.
categoryNoThe type of feedback.
feedbackYesThe user feedback to submit, in clear prose. Summarize the bug, gap, or request.
page_urlNoThe documentation page URL the feedback relates to, if known.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations (openWorldHint=true, destructiveHint=true) the description discloses that a Redpanda Cloud sign-in is required, that the user's work email and company domain are attached, and precisely how to react to an authentication_required refusal (tell the user to reconnect rather than retry). That is exactly the kind of side-effect and auth context annotations alone cannot carry.

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?

The purpose is front-loaded in the opening sentence and each subsequent sentence carries distinct load (consent, data disclosure, auth requirement, failure handling). It is on the long side, but the length is justified by the compliance and auth behavior it documents rather than padding.

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?

With no output schema, the description still covers what the agent needs: trigger conditions, consent requirement, what data leaves the client, and how to handle auth failure. Nothing material for correct invocation is missing.

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 guidance: it instructs the agent to summarize feedback clearly and to include the documentation page URL or context when known, which maps directly to filling page_url and context meaningfully. It also implicitly reveals that email/domain are attached server-side without being schema fields.

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?

The description states a specific verb and resource — 'Send feedback about the Redpanda documentation or products directly to the Redpanda team' — and the delivery target is explicit. It is clearly distinguishable from the sibling read/search tools (ask_redpanda_question, search_api_reference, etc.), which cannot send anything.

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?

It enumerates the exact triggering conditions (bug, documentation gap, incorrect or missing info, user frustration), mandates asking for consent first, and explicitly says 'never submit feedback without their consent.' It also gives a when-not-to-retry rule tied to the authentication_required refusal, which is unusually complete routing guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.