Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get people

xmatters_get_people
Read-onlyIdempotent

Retrieve people records from xMatters using query filters for attributes like name, email, groups, and status to get user details.

Instructions

Get people. GET /api/xm/1/people. Body fields: none. Reference: https://help.xmatters.com/xmapi/#get-people

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNoAPI query parameters; arrays are comma-joined. Documented names: createdAfter, createdBefore, createdFrom, createdTo, devices.exists, devices.email.exists, devices.failsafe.exists, devices.mobile.exists, devices.sms.exists, devices.voice.exists, devices.status, devices.testStatus, emailAddress, embed, fields, firstName, groups, groups.exists, lastName, licenseType, operand, phoneNumber, propertyNames, propertyValues, roles, search, site, sortBy, sortOrder, status, supervisors.exists, supervisors, targetName, webLogin. 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.6/5.0
Behavior2/5

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

Annotations already provide readOnlyHint, idempotentHint, and non-destructive status. The description adds only the HTTP endpoint and 'Body fields: none'; it does not disclose return shape, pagination behavior, or any API-specific caveats beyond structured data.

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 elements each earn their place: the action, the exact endpoint, the body-field clarification, and a direct API reference. It is front-loaded and has 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 read-only, zero-required-parameter collection endpoint, the combination of exact endpoint, no-body note, rich query schema, and reference link is sufficient for an agent to invoke it correctly. It could be more self-contained by summarizing return format, but the API reference mitigates that gap.

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?

Schema coverage is 100% and the query parameter object is well documented, so the baseline is 3. The description adds a small but useful clarification that no body fields are expected, which is not explicit in the input 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?

Description names the exact resource ('people') and HTTP operation ('GET /api/xm/1/people'), making it unmistakably a collection listing operation. This distinguishes it from siblings like xmatters_get_a_person_by_id and xmatters_get_devices.

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 call this versus alternatives. It does not state that this returns the full people collection, that it supports filtering via query parameters, or that get_a_person_by_id should be used for a single person.

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