Skip to main content
Glama

Open Agent Guide

Submit Feedback

submit_feedback

Report a bug, request a feature, or flag a docs problem about Open Agent Guide itself — the service, the API, or the docs — at the moment you hit it, instead of a hand-rolled HTTP call. Use this for feedback about the guide; to change catalog data (add or correct a product), use the HTTP submissions API. Needs your API token: register this MCP server with a personal token, or sign up at /api/v1/users/signup/. Submit-only — there is no read-back, response, or status. Send plain text; markup is rejected. title and body have size caps and an over-cap field is rejected, not truncated, so shorten and resend. Do not tag the feedback as a bug or feature request — classification is applied at triage. Returns a short receipt (id, title, created_at, submitted_by).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "title": "<title>",
      "body": "<body>"
    },
    "name": "submit_feedback"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesPlain-text detail. Bounded by a size cap; an over-cap body is rejected, not truncated.
titleYesShort plain-text summary of the problem or request.
contextNoOptional structured context about where you hit this.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare non-read-only, non-idempotent, non-destructive, open-world behavior, but the description adds substantial context: authentication requirement, submit-only with no read-back/status, plain-text-only with markup rejected, over-cap fields rejected rather than truncated, and classification deferred to triage. It does not discuss rate limits or what happens on auth failure, which keeps it short of a 5 for a mutation tool.

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?

Front-loads purpose, then constraints, then return shape in a logical order with no filler sentences. It is on the long side and repeats the size-cap rejection rule that already appears in the schema, which costs it a point.

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?

Covers auth, submission semantics, content format restrictions, classification policy, and return receipt, which is everything an agent needs before calling a create-style tool. With an output schema present, the brief receipt mention is sufficient rather than redundant.

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 behavioral meaning beyond the schema: title/body must be plain text, size caps cause rejection rather than truncation, and the agent should not self-classify as bug or feature request. The over-cap rejection rule largely duplicates the body field's own schema description, so the added value is real but not fully independent.

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?

States a specific verb set (report a bug, request a feature, flag a docs problem) scoped explicitly to 'Open Agent Guide itself — the service, the API, or the docs'. It also distinguishes itself from a sibling path by naming the HTTP submissions API for catalog data changes, so an agent can route without opening either schema.

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?

Gives explicit when-to-use ('at the moment you hit it, instead of a hand-rolled HTTP call'), an explicit when-not-to-use alternative (change catalog data via the HTTP submissions API), and a prerequisite (personal API token or signup URL). The submit-only constraint further bounds when this tool is appropriate.

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.

Resources