Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Unsubscribe a user

xmatters_unsubscribe_a_user
Destructive

Unsubscribe a user from a subscription in xMatters so they no longer receive notifications for it.

Instructions

Unsubscribe a user. DELETE /api/xm/1/subscriptions/{subscriptionId}/subscribers/{personId}. Body fields: none. Reference: https://help.xmatters.com/xmapi/#unsubscribe-a-user Requires operator write opt-in and confirm:true; may notify recipients or change tenant data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
queryNoAPI query parameters; arrays are comma-joined. Documented names: none. Pagination is explicit using offset and limit; results are not automatically combined.
confirmYesExplicit approval of this exact mutation. Operator must also enable XMATTERS_ALLOW_WRITES.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already mark it as destructive and non-idempotent, but the description adds critical context: the need for operator write opt-in, the confirm:true requirement, and potential side effects like notifying recipients or changing tenant data. This goes beyond the structured annotations and helps the agent anticipate consequences.

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?

The description is compact and front-loaded with the action and endpoint. It includes a reference link and essential caveats in a single paragraph. While it could be formatted more cleanly with bullet points, it contains no filler and efficiently conveys the key information.

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 destructive mutation with no output schema, the description covers the essential aspects: the operation, required path parameters, confirmation requirement, and side effects. The schema handles parameter details, so the description is sufficiently complete for an agent to invoke it correctly, though it does not address error handling or return behavior.

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 67% (query and confirm have descriptions, path does not). The tool description mentions the endpoint with {subscriptionId} and {personId}, which clarifies the path parameters, and states 'Body fields: none'. However, it does not elaborate on the query parameter's purpose or pagination beyond what the schema already states, so it only partially compensates for the schema gaps.

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 clearly states the action ('Unsubscribe a user') and provides the exact HTTP DELETE endpoint, which unambiguously identifies the resource and operation. This distinguishes it from sibling tools like add_subscribers or get_subscribers, and the inclusion of the API reference link adds further specificity.

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?

The description implies when to use it (to remove a subscriber from a subscription) but does not explicitly contrast it with alternatives or state when not to use it. It does mention prerequisites (operator write opt-in and confirm:true) which is helpful, but lacks explicit routing to other tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools