Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Get scenario sender permissions

xmatters_get_scenario_sender_permissions
Read-onlyIdempotent

Retrieve sender permissions for a specific xMatters scenario to verify which senders are allowed.

Instructions

Get scenario sender permissions. GET /api/xm/1/scenarios/{scenarioId}/sender-permissions. The table calls the scenario path identifier id and labels it QUERY PARAMETERS; the definition uses scenarioId in the path. See C06. Body fields: none. Reference: https://help.xmatters.com/xmapi/#get-scenario-sender-permissions

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.5/5.0
Behavior3/5

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

Annotations already mark the tool read-only, idempotent, and non-destructive; the description adds the HTTP method, the exact endpoint, and 'Body fields: none.' It also flags the documentation mismatch around path vs query naming. It does not describe auth, rate limits, or pagination responses, but for a safe read operation with these annotations the added context is adequate.

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?

Each sentence is short and purposeful, with the purpose front-loaded and technical details kept to the end. The cryptic 'See C06' and the reference URL are minor clutter but not verbose.

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 read-only resource with strong annotations and a schema that already documents query and pagination behavior, the description is largely complete: it gives the endpoint, path parameter naming caveat, and a reference. It omits response shape and authorization, but the resource name and GET semantics make the return value predictable.

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 schema documents the query object but leaves path.scenarioId without a description, so the description's notice that the path identifier is scenarioId (not the table's 'id') is valuable. It also states there is no body. However, it does not explain the meaning or format of sender permissions beyond the endpoint, so the description only partly compensates for the 50% schema coverage.

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 opens with a specific verb and object ('Get scenario sender permissions') and states the exact endpoint with the resource path, making the operation unambiguous. It is naturally distinguished from the sibling set_scenario_sender_permissions by the GET verb and resource name.

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 about when to prefer this tool over its setter counterpart or how it relates to the form sender-permission tools; the only signal is the verb 'Get'. The description does not mention prerequisites, exclusions, or alternatives, so an agent must infer usage from the endpoint.

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