Skip to main content
Glama

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 documentation page path the feedback is about (e.g., the page you were reading, such as `/quickstart`).
feedbackYesA clear description of the documentation issue or suggestion — what is incorrect, outdated, missing, or confusing.

TDQS

A4.5/5.0
Behavior4/5

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

With annotations already marking the tool as non-read-only and non-idempotent, the description adds useful context: it explains the intended audience and outcome (docs team will fix), and reiterates what is not in scope. It does not mention side effects like duplicate submissions, but the action is low-risk and the annotations cover the basic mutation profile.

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?

Two sentences, front-loaded with the main action, followed by conditions and exclusions. Every phrase earns its place; there is no redundancy or tangential content.

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 simple 2-parameter submission tool with complete schema descriptions and adequate annotations, the description covers the human-readable context sufficiently: what the tool does, when to use it, and what it is not for. No return-output details are necessary because no output schema exists and the submission is a fire-and-forget feedback action.

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?

The input schema covers 100% of parameters with clear descriptions, including an example for `path` and guidance for `feedback`. The description reinforces the semantic context but adds no newly meaningful detail beyond schema content, so baseline 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 opens with a specific verb-resource pair: 'Report a problem with this documentation site so the docs team can fix it.' It further clarifies the target scope and distinguishes from unrelated siblings by naming the exact feedback categories (incorrect, outdated, confusing, incomplete, broken example).

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 explicitly states when to use the tool—when a documentation page is incorrect, outdated, confusing, incomplete, or has a broken example—and explicitly excludes product support requests and feedback about the tool/assistant. This provides clear boundaries without needing a named alternative tool.

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.

TDQS

A4.4/5.0
Disambiguation5/5

Each tool has a clear, distinct purpose: query_docs_filesystem for reading full pages, search_political_comms for finding relevant snippets, and submit_feedback for reporting issues. No overlap in functionality.

Naming Consistency2/5

Tool names are inconsistent: one is very long with nested underscores (query_docs_filesystem_political_comms), another is shorter (search_political_comms), and submit_feedback follows a different pattern. No consistent verb_noun structure across all names.

Tool Count4/5

Three tools cover the core needs of documentation access and feedback. While slightly minimal, the set is well-scoped for its purpose and does not feel bloated or incomplete.

Completeness4/5

The server provides search and full-page retrieval (via filesystem commands) plus feedback. Users can explore, read, and report issues. Minor gap: no dedicated 'list pages' tool, but tree/ls in query covers it. Suitable for the domain.

Resources