Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Get user delivery data

xmatters_get_user_delivery_data
Read-onlyIdempotent

Retrieve user delivery details for a specific event at a historical timestamp. Check notification status and recipient delivery results for a given event.

Instructions

Get user delivery data. GET /api/xm/1/events/{eventID}/user-deliveries. Historical-data endpoint: at is required. Event identifier casing follows DEFINITION (eventID), not the table spelling eventId. Body fields: none. Reference: https://help.xmatters.com/xmapi/#get-user-delivery-data

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
queryYesAPI query parameters; arrays are comma-joined. Documented names: embed, sortBy, sortOrder, deliveryStatus, offset, limit, at. Pagination is explicit using offset and limit; results are not automatically combined.

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?

With annotations already marking the operation as read-only and idempotent, the description adds useful behavioral context: it is a historical-data endpoint, 'at' is mandatory, eventID casing must follow the definition spelling, and no body is sent. No contradiction with annotations exists.

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: endpoint, historical requirement, casing caveat, body expectation, and reference link all fit in five short clauses. Every sentence earns its place without 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 read-only historical endpoint, the description plus the schema's query-parameter documentation is sufficient for an agent to select and invoke the tool correctly. A brief note about the response shape would make it fully complete, but the resource and required inputs are clear.

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 description reinforces that 'at' is required and clarifies the eventID casing distinction, which the schema alone does not provide. The schema's query-object description already documents other query parameters and pagination behavior, so the description complements rather than duplicates it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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 ('Get user delivery data') and provides the exact REST path with eventID and user-deliveries. It is clearly distinguishable from sibling event tools, though it does not explicitly name an alternative or a when-not-to-use condition.

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?

It clearly identifies this as a historical-data endpoint, states that 'at' is required, and notes that no body fields are expected. It does not mention alternative tools or exclusion criteria, but the call context is unambiguous.

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