Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Get shifts

xmatters_get_shifts
Read-onlyIdempotent

Retrieve shift schedules for a group using the xMatters API. Specify the group ID to get its shifts, with options to filter by shift type or creation date.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
queryNoAPI query parameters; arrays are comma-joined. Documented names: embed, include, members.exists, shiftType, createdBefore, createdAfter. 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.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, covering the safety profile. The description adds 'Body fields: none' and the HTTP GET method, but does not disclose pagination, response shape, or other behavioral details; this is acceptable but not additive enough for a higher score.

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 compact and front-loads the endpoint and key constraints, with a reference URL for details. The opening 'Get shifts' repeats the title, so it is not perfectly economical, but the overall structure wastes little space.

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?

The endpoint, body note, and reference are sufficient to make the call, and the schema covers query parameters. However, there is no output description and no disambiguation among the many sibling shift tools, so an agent may need extra effort to decide this is the right tool.

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 makes the required groupID path parameter explicit and 'Body fields: none' clarifies there is no request body, but query parameters are only documented in the schema rather than the description. With 50% schema description coverage, the description only partially compensates for parameter semantics.

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 names the operation ('Get shifts') and supplies the exact endpoint 'GET /api/xm/1/groups/{groupID}/shifts', making clear it retrieves shift collections for a group. The plural 'shifts' and the groupID path segment differentiate it from singular shift tools, though it does not explicitly call out those siblings.

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?

No guidance is given on when to use this tool versus alternatives such as xmatters_get_a_shift or xmatters_get_members_in_a_shift. The endpoint and reference imply the resource scope, but the description does not state when to choose this over sibling shift-related tools.

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