Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Delete a plan constant

xmatters_delete_a_plan_constant
Destructive

Delete a plan constant using its plan ID and constant ID. This mutation removes the constant value from a plan and requires explicit confirmation plus write access.

Instructions

Delete a plan constant. DELETE /api/xm/1/plans/{planId}/constants/{constantId}. Body fields: none. Reference: https://help.xmatters.com/xmapi/#delete-a-plan-constant 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

A4.2/5.0
Behavior5/5

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

The description adds substantial context beyond the destructiveHint and readOnlyHint annotations: it requires operator write opt-in and confirm:true, and warns that the action may notify recipients or change tenant data. This meaningfully signals side effects an agent should consider before calling the tool.

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?

The description is compact, front-loaded with the core action, and each sentence carries useful information: endpoint, body expectations, reference, and required safeguards. There is no filler or repetition of the obvious.

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 critical operational details: HTTP method, path, confirmation requirement, opt-in, and potential side effects. It could be slightly more complete by stating what a successful response looks like or explicitly contrasting with the modify and create siblings, but it is not missing essential safety information.

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?

The endpoint template adds some meaning by showing planId and constantId as path variables, and the description restates the confirm:true requirement, but the schema already documents confirm and query. The planId and constantId properties themselves remain undocumented in both schema and description, so the description only partially compensates.

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 exact operation, 'Delete a plan constant', and reinforces it with the full DELETE endpoint, so the verb and resource are unmistakable. It is also clearly distinct from sibling tools like create/modify/get plan constants.

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?

Use is implied by the operation name and description, but no explicit guidance is given about when to choose this tool over related tools such as modify_a_plan_constant or get_plan_constants. The confirmation and opt-in requirements are operational constraints, not usage comparisons.

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