Skip to main content
Glama

DarkFunnels documentation

Submit documentation feedback

submit_feedback

Report a problem with this documentation site so the docs team can fix it. Use when a documentation page is incorrect, outdated, confusing, incomplete, or has a broken example. This is for feedback about the documentation content itself — not for product support requests or feedback about this tool or assistant.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesThe URL path of the documentation page the feedback is about (the page you were reading, without the `.mdx` extension).
feedbackYesA clear description of the documentation issue or suggestion — what is incorrect, outdated, missing, or confusing.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / path / description
      Previous value: -"The documentation page path the feedback is about (e.g., the page you were reading, such as `/quickstart`)."New value: +"The URL path of the documentation page the feedback is about (the page you were reading, without the `.mdx` extension)."
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already convey that this is a write operation (readOnlyHint=false, idempotentHint=false), and the description adds meaningful context: feedback is routed to the docs team and is scoped to documentation content. It stops short of describing what happens after submission (e.g., whether a confirmation is returned, whether it creates an issue), but it does not contradict the annotations and provides useful behavioral framing.

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?

Three sentences, all informative. The first sentence states the purpose, the second gives concrete usage criteria, and the third excludes non-documentation feedback. No filler or redundancy; the most important information is front-loaded.

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 two-parameter tool with no output schema, the description and schema together cover the essential information: what to submit, which page, what kind of feedback, and when to use it. The only minor gap is the lack of detail about the post-submission result or confirmation behavior, which is not critical but would make it fully complete.

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%, and the parameter descriptions already explain 'path' (URL path without .mdx extension) and 'feedback' (clear description of the issue). The tool description reinforces the kind of feedback expected but adds no technical semantics beyond the schema, so the baseline score of 3 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?

The description clearly states the tool's function: 'Report a problem with this documentation site so the docs team can fix it.' It identifies the specific resource (documentation site) and the action (reporting a problem), and it distinguishes itself from the sibling query/search tools by being feedback-oriented. It also explicitly carves out what it is not for: product support or feedback about the tool/assistant.

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 guidance: 'Use when a documentation page is incorrect, outdated, confusing, incomplete, or has a broken example.' It also provides a clear when-not-to-use boundary: 'not for product support requests or feedback about this tool or assistant.' This is strong, actionable usage direction.

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.