Skip to main content
Glama

Hide a change

hide_change

Hide a detected change from your history and recent changes to suppress a false alarm without deleting it; teammates still see it and you can restore it later.

Instructions

Hide one detected change from this user's history and recent changes, for example a false alarm (requires a write-scope API key). Nothing is deleted and teammates still see it; unhide_change brings it back, and includeHidden shows hidden ones.

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": {
      "uuid": "<uuid>",
      "checkId": "<checkId>"
    },
    "name": "hide_change"
  }
}

Input Schema

NameRequiredDescriptionDefault
uuidYesMonitor uuid
checkIdYesCheck id of the change (from get_recent_changes or get_check_history)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

A4.5/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it discloses the write-scope API key requirement, that nothing is deleted, that visibility is per-user (teammates still see it), and that the action is reversible via unhide_change.

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?

One tightly packed sentence with the core action and scope front-loaded, followed by the auth requirement, side-effect clarification, and reversal path. Every clause earns its place.

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 two-parameter mutation with no output schema, the description covers the safety profile, reversibility, scope of effect, auth prerequisites, and related tools — everything an agent needs before calling it.

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%, with both uuid and checkId documented in the schema including the source of checkId. The description adds no parameter-specific meaning, so the baseline 3 applies.

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 and resource ('Hide one detected change from this user's history and recent changes') and names the complementary sibling, unhide_change, so an agent can distinguish the pair immediately.

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?

It gives a concrete when-to-use example ('for example a false alarm') and points to alternatives: unhide_change to reverse it and includeHidden to surface hidden items. It does not state when hiding is inappropriate, which keeps it just 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.