Skip to main content
Glama

Rate an edit

barevalue_feedback

Records the user's rating of a finished order, positive or negative, with an optional comment and list of issues. Our team is told. A second rating for the same order replaces the first, comment included.

Input Schema

NameRequiredDescriptionDefault
issuesNoOptional: what was wrong
ratingYesWhether the user is happy with the edit
api_keyNoBarevalue API key (bv_sk_...), as returned by barevalue_register. Not needed when the connection already sends an Authorization: Bearer header.
commentNoOptional: what the user said, in the user's own words (max 2000 characters)
order_idYesOrder ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / api_key / description
      Previous value: -"Barevalue API key (bv_sk_...). Get one with barevalue_register. Omit when the connection already sends an Authorization: Bearer header."New value: +"Barevalue API key (bv_sk_...), as returned by barevalue_register. Not needed when the connection already sends an Authorization: Bearer header."
    • changedInput schema / properties / comment / description
      Previous value: -"Optional: what they said, in their words (max 2000 characters)"New value: +"Optional: what the user said, in the user's own words (max 2000 characters)"
    • changedInput schema / properties / rating / description
      Previous value: -"Whether your user is happy with the edit"New value: +"Whether the user is happy with the edit"
  2. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnlyHint=false, destructiveHint=false, openWorldHint=true), and the description adds genuinely useful behavior beyond them: a second rating for the same order replaces the first, comment included (upsert semantics), and 'Our team is told' (human notification side effect). It stops short of stating idempotency limits or whether replacing is reversible.

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?

Three short sentences, front-loaded with the core action and the replacement rule, with no filler. 'comment included' is mildly redundant with the preceding clause but costs little.

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 5-parameter write tool with full schema coverage, no output schema, and annotations present, the description supplies the one non-obvious trait (replacement of a prior rating) plus the notification side effect. Auth via api_key and the issues enum are already handled by the schema, so nothing essential is missing.

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 order_id, rating, comment, issues and api_key are all documented in the schema; baseline is 3. The description restates that comment and issues are optional and that rating is positive/negative, adding no format, length, or enum detail beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Records the user's rating of a finished order') plus the value space (positive/negative) and optional payload, so the agent knows exactly what the tool does. It does not explicitly distinguish itself from the nearest sibling, barevalue_request_revision, which is the main confusion risk for an agent choosing between rating an edit and asking for changes.

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?

Usage is implied by 'finished order' – rate after the edit is delivered – but there is no explicit when/when-not guidance and no named alternative (e.g., use request_revision instead when the user wants the edit redone). The agent must infer the boundary from sibling names.

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.