Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Create a temporary absence

xmatters_create_a_temporary_absence
Destructive

Create a temporary absence for a user in xMatters, specifying start/end times and optional replacement. Use it to schedule coverage or block notifications during planned time off.

Instructions

Create a temporary absence. POST /api/xm/1/temporary-absences. replacement is conditional on absenceType=REPLACEMENT and tenant policy; not required globally. Body fields: id, absenceType, member, start, end, group, includeDirectNotifications, replacement. Reference: https://help.xmatters.com/xmapi/#create-a-temporary-absence 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-temporary-absence
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.1/5.0
Behavior4/5

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

Annotations already specify destructiveHint=true and readOnlyHint=false, so the mutation behavior is known. The description adds value by noting that it may notify recipients or change tenant data, and that it requires operator write opt-in and confirm:true, which are specific behavioral conditions beyond the generic annotation. It does not contradict annotations and provides useful extra detail.

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 a compact paragraph that covers the essential points: purpose, endpoint, key conditional, body fields, reference, and requirements. It front-loads the action and includes critical constraints without excessive verbosity. It could be slightly more structured with bullets, but it's efficient and readable.

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?

Given the tool has nested objects and requires a JSON payload, the description provides enough context for an agent to understand it must construct a body and confirm true, with a pointer to external docs. It doesn't explain return values, but there's no output schema and that may not be critical. The main gap is lack of explicit pagination or error handling info, but the reference is provided. Overall, it's sufficient for basic invocation.

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 coverage is 100% (as indicated), so the schema describes both body and confirm parameters. The description adds details about the body fields (id, absenceType, etc.) and the conditional nature of replacement, which goes beyond the schema's generic description. However, it doesn't fully elaborate on each field's meaning, so it adds moderate value but not exhaustive semantics.

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 it creates a temporary absence via a specific API endpoint, and the title reinforces the action. It includes the required HTTP method and path. It is distinct from sibling tools like get/delete temporary absences, and the description's reference to body fields adds specificity.

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 provides some context on when this tool is applicable, mentioning the conditional replacement field and the need for operator write opt-in and confirm:true. However, it does not explicitly state when to prefer this over other mutation tools or when not to use it, though the API-specific nature makes usage fairly clear. It lacks exclusions or 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