Skip to main content
Glama

Nopaque TotalPath

Get Alert Rule

getAlertRule
Read-onlyIdempotent

Get one alert rule by id (from listAlertRules), with its last 50 state changes (when it went into alarm or recovered, and why) and, for a schedule or test rule, the outcomes of up to 10 recent runs it watched. Use when: the user asks when an alert fired, or why it is in alarm. Read-only. Needs notifications:read. Returns 404 if the rule is not in your workspace. Only a person signed in to the nopaque web app can call this; an API key is refused.

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": {
      "id": "<id>"
    },
    "name": "getAlertRule"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesAlert rule id, from listAlertRules.

Output Schema

NameRequiredDescriptionDefault
ruleYesAn alert rule as the API returns it. Internal join keys, and who else asked for in-app alerts, are left out.
recentRunsYes
transitionsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare readOnly, idempotent, non-destructive, but the description adds material context they cannot carry: required notifications:read scope, an explicit 404 when the rule is outside the caller's workspace, and a caller restriction (signed-in web app user only, API keys refused). These are exactly the auth and failure-mode facts an agent needs before calling.

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?

Front-loaded with purpose and return payload, then the usage condition, then access constraints — a natural reading order for an agent. Every clause carries distinct information (scope, return shape, trigger, permissions, error case, caller restriction) with no redundancy.

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 single-parameter read tool this covers what matters: what comes back, when to reach for it, required scope, and the 404 and auth failure modes. An output schema exists, so the brief summary of return contents is a bonus rather than a burden, and nothing an agent needs to invoke it correctly 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 coverage is 100% and the schema property already says 'Alert rule id, from listAlertRules.' The description's phrasing mirrors that wording rather than extending it with format, accepted prefixes, or ID vs. name distinctions. Baseline 3 is the right ceiling when the schema does the heavy lifting.

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 ('Get one alert rule by `id`') plus the exact payload returned: last 50 state changes with alarm/recovery reasons and up to 10 recent run outcomes. The parenthetical '(from listAlertRules)' makes clear it is the single-record counterpart to that sibling, so the agent can separate the two 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 Guidelines4/5

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

Explicit 'Use when: the user asks when an alert fired, or why it is in alarm' gives a concrete triggering condition, and it routes the agent to listAlertRules for obtaining the id. It stops short of stating when NOT to use it (e.g., bulk listing, or retrieving runs directly), so it is strong context rather than a full decision rule.

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.