Skip to main content
Glama

Report a code change

report_change

Beta. Report a code change to Helprism after judging its help-center impact (helprism-sync skill). Send only paths, the impact note and help-article prose: never code, diffs or file contents. Nothing publishes: update/create drafts go to the review inbox, verify goes to the freshness list. Returns the change id, suggestion ids and a reviewUrl to show the user. Works on Pro and Business.

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": {
      "ref": "<ref>",
      "title": "<title>",
      "impactNote": "<impactNote>",
      "changeClass": "<changeClass>"
    },
    "name": "report_change"
  }
}

Input Schema

NameRequiredDescriptionDefault
refYesThe commit or PR this report is about
titleYesShort title of the change (e.g. the commit subject)
impactNoteYes"Help center impact: NONE" or "Help center impact: <what changed for a user>"
changeClassYesThe class from the skill. Stopping classes carry no suggestions
suggestionsNoEmpty when nothing in the help center needs to change
filesTouchedNoRepository paths the change touched. Paths only, no contents
procedureVersionNoWhich skill rules produced this reportv3-4544eddb

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Adds substantial context beyond the annotations: nothing publishes, drafts route to a review inbox, verify goes to a freshness list, and it is gated to Pro/Business and beta. It also discloses the return payload (change id, suggestion ids, reviewUrl), which matters because there is no output schema.

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-loaded with the beta flag and the core action, then constraints, then routing behavior, then return values and plan gating. Dense and largely waste-free, though the plan sentence and the return sentence could be tightened.

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 7-parameter, nested-object mutation with no output schema, the description covers the missing pieces: what is returned, what does not happen (no publishing), plan availability, and the payload boundary. Nothing an agent needs to call it correctly is absent.

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 schema already carries per-parameter meaning and the baseline is 3. The description adds a cross-cutting constraint the schema cannot express — never send code, diffs or file contents — and highlights the impact note and prose as the only content payload.

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 and resource ('Report a code change to Helprism') plus the prerequisite judgement step. It is clearly distinguished from siblings like create_article or resolve_suggestion because this is the upstream intake path, not a help-center edit.

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

Usage Guidelines4/5

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

Gives a clear precondition ('after judging its help-center impact (helprism-sync skill)') and a payload restriction ('send only paths, the impact note and help-article prose'). It does not name competing siblings or say when not to report, so it stops short of a 5.

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