Skip to main content
Glama

Submit docs feedback

submit_feedback

Send feedback about the documentation — a correction, something confusing, something missing. Stored for the docs team.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoWhat kind of feedback this is
pageNoPage path or URL the feedback is about
contactNoOptional contact (email/handle) for follow-up
messageYesThe feedback itself

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are provided, so the description carries full burden. It discloses that feedback is stored for the docs team, indicating a non-destructive write operation. However, it does not mention any other behavioral traits like authentication or rate limits, leaving gaps.

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?

The description is extremely concise with no wasted words. Two short sentences convey purpose and outcome efficiently.

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 4-parameter tool with no output schema and no nested objects, the description and schema together provide sufficient information. The description clarifies the purpose and the schema covers parameter details.

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%, so parameters are already documented. The description adds no additional meaning beyond the schema, meeting the baseline for high coverage.

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 action ('Send feedback'), the resource ('documentation'), and examples of feedback types (correction, confusing, missing). It implicitly differentiates from siblings like ask_docs and raise_issue, as it focuses on documentation feedback.

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

Usage Guidelines3/5

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

The description implies usage for documentation feedback but provides no explicit guidance on when to use this tool versus alternatives (ask_docs, raise_issue). No exclusions or context are given.

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/5.0
Disambiguation5/5

Each tool targets a distinct action: Q&A, issue filing, page reading, searching, and feedback submission. There is no overlap in functionality.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (ask_docs, raise_issue, read_page, search_docs, submit_feedback), making them predictable.

Tool Count5/5

5 tools is well-scoped for a documentation server. It covers the primary user interactions without being excessive or insufficient.

Completeness4/5

The set covers core operations (search, read, ask, file issues, give feedback). Minor omission is a browse or list pages tool, but search compensates.