Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Modify a shared library

xmatters_modify_a_shared_library
Destructive

Modify a shared library's name or script via the xMatters API. Requires explicit write opt-in and confirmation to apply changes.

Instructions

Modify a shared library. POST /api/xm/1/shared-libraries. Body fields: id, name, script. Reference: https://help.xmatters.com/xmapi/#modify-a-shared-library Requires operator write opt-in and confirm:true; may notify recipients or change tenant data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesComplete API JSON payload (including nested fields). See https://help.xmatters.com/xmapi/#modify-a-shared-library
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
Behavior4/5

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

Annotations already mark the operation as destructive and non-read-only; the description adds meaningful behavior beyond that by warning that it may notify recipients or change tenant data, and by making the operator opt-in requirement explicit. It does not contradict the annotations.

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 and front-loaded: action, endpoint, body fields, then requirements and side effects. Every sentence contributes useful information with no redundancy or filler.

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, the description covers the endpoint, auth/confirmation requirement, side effects, and provides a reference link. It does not describe the return value in detail, but there is no output schema and the reference link lessens that gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds value by naming the concrete body fields (id, name, script), which the generic recursive body schema alone does not reveal, and the reference link compensates for the generic body type.

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 a specific action and resource: 'Modify a shared library', backed by the exact endpoint and body fields. This differentiates it from the sibling create/get/delete shared-library tools.

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 intended use is implied by the verb and endpoint, and the description notes required prerequisites (operator write opt-in and confirm:true). However, it does not explicitly contrast this with creating or deleting a shared library, or explain when to prefer this over those alternatives.

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