Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Delete a scheduled message

xmatters_delete_a_scheduled_message
Destructive

Cancel a scheduled message before it sends. Use with explicit confirmation to remove the message and prevent recipient notification.

Instructions

Delete a scheduled message. DELETE /api/xm/1/scheduled-messages/{scheduledMessageId}. Body fields: none. Reference: https://help.xmatters.com/xmapi/#delete-a-scheduled-message 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.7/5.0
Behavior4/5

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

Annotations already mark this as destructive and non-idempotent; the description adds meaningful context by stating that deletion may notify recipients or change tenant data and by calling out the operator write opt-in requirement. This goes beyond the structured annotations without contradicting them.

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-loads the core purpose before side effects and prerequisites. The reference URL is mildly redundant for an agent, but the overall length is appropriate and every major sentence adds useful 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 delete operation with no output schema, the description covers the essential operational caveats: required confirmation, operator write opt-in, potential recipient notification, and tenant data changes. It does not describe response codes, but that is a minor gap for a simple DELETE endpoint.

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%, so the schema carries most of the parameter meaning for `path` and `confirm`. The description adds the endpoint template and "Body fields: none," but it does not explain the scheduledMessageId format or add much semantic value beyond what the schema already provides.

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 the specific action and resource: "Delete a scheduled message," then reinforces it with the exact REST endpoint. This clearly distinguishes it from the scheduled-message create, modify, and get siblings.

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

Usage Guidelines2/5

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

The description gives prerequisites (operator write opt-in and confirm:true) but provides no guidance about when to choose this tool instead of an alternative, nor any "when not to use" exclusions. There is no comparison to sibling tools such as modifying or getting a scheduled message.

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