Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Get a group's recipients

xmatters_get_a_group_39_s_recipients
Read-onlyIdempotent

Fetch the recipients assigned to an xMatters group by supplying the group ID. Returns the list of members for use in notification targeting.

Instructions

Get a group's recipients. GET /api/xm/1/groups/{groupId}/recipients. Body fields: none. Reference: https://help.xmatters.com/xmapi/#get-a-group-39-s-recipients

Input Schema

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

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnly/idempotent/non-destructive behavior, so the description's main additions are the endpoint and 'Body fields: none'. No contradiction exists, though the description could have disclosed more about response shape or pagination; the query schema partially covers pagination.

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?

Four short sentences each carry useful information: action, endpoint, body requirement, and reference link. Purpose is front-loaded and there is no 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 simple one-required-parameter GET, the description, schema, and annotations together are sufficient to invoke it correctly. It lacks a description of the return value, but the resource name and reference link partially compensate.

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 description confirms groupId is a path segment and states there is no request body, but it does not explain groupId semantics beyond what the name implies. The query schema already documents comma-joined arrays and explicit offset/limit pagination, so the description adds only marginal value over the schema.

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 the exact action and resource ('Get a group's recipients') and reinforces it with the explicit HTTP endpoint. This cleanly differentiates it from sibling tools like get_group_members or get_a_group_39_s_supervisors.

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

Usage Guidelines3/5

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

The endpoint and resource imply it should be used when the agent needs the recipient list of a specific group, but the description does not explicitly state when to prefer it over alternatives or mention exclusions. The 'Body fields: none' note is a mild usage constraint but not a when-to-use statement.

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