Skip to main content
Glama

Submit Documentation Feedback

submit_documentation_feedback

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?

No annotations are provided, so the description carries the full burden. It discloses side effects (feedback sent to Redpanda team, work email and company domain attached), the sign-in requirement, and the exact behavior on auth failure. This is strong transparency for a tool with no annotation coverage.

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 description is well-structured: purpose first, then consent and content guidance, then authentication handling. It is longer than minimal, but each sentence carries operational value; the auth section is detailed but necessary for correct failure recovery.

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 4-parameter submission tool with no output schema and no annotations, the description is complete: it covers consent, content, authentication prerequisites, and error handling. An agent has everything needed to decide when to call, what to submit, and how to recover from auth failures.

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 adds meaningful guidance by telling the agent to summarize feedback clearly and include the relevant documentation page URL or context, which clarifies how the feedback and page_url parameters should be populated beyond their schema descriptions.

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 action ('Send feedback... directly to the Redpanda team') with a clear resource and recipient. It is distinct from the sibling reference and Q&A tools, which are read/answer oriented rather than submission-oriented.

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?

The description gives explicit when-to-use triggers (bug, documentation gap, incorrect/missing information, frustration), requires asking the user and obtaining consent, and explicitly forbids calling without consent. It also provides concrete handling for the authentication_required failure, including reconnecting instructions and when not to retry.

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.