Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Get a shift

xmatters_get_a_shift
Read-onlyIdempotent

Retrieve details of a specific shift by providing group and shift IDs. Use this tool to get shift information directly from xMatters for scheduling or on-call management.

Instructions

Get a shift. GET /api/xm/1/groups/{groupID}/shifts/{shiftID}. Body fields: none. Reference: https://help.xmatters.com/xmapi/#get-a-shift

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
queryNoAPI query parameters; arrays are comma-joined. Documented names: embed, include. 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

B3.4/5.0
Behavior3/5

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

Annotations already establish that the operation is read-only, idempotent, and non-destructive. The description adds only the HTTP method and the fact that there is no request body; it does not disclose auth requirements, error behavior, or response shape, but for a simple GET with strong annotations this is acceptable.

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 short, front-loaded with the operation, and every line has a purpose: the action, the endpoint, the body requirement, and a reference link. The 'Get a shift' sentence is slightly redundant with the title, but the overall structure is efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read operation with well-defined IDs, the description plus schema and annotations are mostly sufficient. However, there is no output schema and the description does not mention what the response contains, error conditions, or how embed/include affect results, leaving some ambiguity for an agent.

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 clarifies that groupID and shiftID are path parameters, and 'Body fields: none' removes body-parameter ambiguity. The schema itself covers the query parameter semantics with embed/include and pagination details, though the description does little to explain what groupID and shiftID actually identify beyond their names.

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 clear verb and resource ('Get a shift') and gives the exact endpoint, including the groupID and shiftID path variables. This makes it unambiguous against sibling tools like get_shifts (list) and update_a_shift (mutation).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool versus alternatives such as get_shifts or get_shift_occurrences. The URL implies you need a groupID and shiftID, but it never states the intended scenario or mentions that get_shifts should be used to find shifts.

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