Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Create a device

xmatters_create_a_device
Destructive

Create a device in xMatters by submitting its configuration, such as type, owner, and contact details. Register new notification devices with required confirmation.

Instructions

Create a device. POST /api/xm/1/devices. Device-type-specific fields are conditional. Mobile push devices cannot be created by REST; existing push devices can be modified. Body fields and nested structures remain open. Body fields: defaultDevice, delay, deviceType, id, externalKey, externallyOwned, name, owner, priorityThreshold, provider, recipientType, sequence, status, testStatus, timeframes, emailAddress, phoneNumber, twoWayDevice, pin, country. Reference: https://help.xmatters.com/xmapi/#create-a-device 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/#create-a-device
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.5/5.0
Behavior5/5

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

The description goes well beyond the annotations by stating the API method, the requirement for operator write opt-in, and the side effects that this mutation may notify recipients or change tenant data. Combined with destructiveHint=true and readOnlyHint=false, the agent gets a clear and accurate picture of the operation's impact.

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 dense but not bloated: it front-loads the core action and endpoint, states the key constraint about mobile push devices, lists the body fields, and points to the reference. The field list is long but earns its place given the open body schema and lack of detailed parameter documentation.

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 mutation tool with no output schema and a generic body schema, the description provides necessary context: endpoint, prerequisites, side effects, field names, and a documentation reference. It could add more detail about response behavior or device-type-specific requirements, but the reference and explicit caveats make it reasonably complete for an agent.

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?

The schema coverage is 100%, but for the body parameter the schema is a generic recursive open-world type. The description compensates by enumerating the relevant body field names and noting that device-type-specific fields are conditional and nested structures remain open. This adds real meaning beyond the schema's 'Complete API JSON payload' text.

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 states a specific verb and resource ('Create a device') and backs it with the exact REST endpoint. It also clarifies scope by noting device-type-specific fields and the mobile push device exception, which helps distinguish this create operation from get, modify, and delete device siblings.

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?

The description includes an explicit use-vs-alternative cue: mobile push devices cannot be created via REST and existing push devices can be modified. It also states a prerequisite (operator write opt-in and confirm:true). It does not explicitly name sibling tools like modify_a_device, but the conditional guidance is sufficient for correct routing.

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