Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Get a subscription form

xmatters_get_a_subscription_form
Read-onlyIdempotent

Retrieve a subscription form by its ID to view notification preferences or configuration details.

Instructions

Get a subscription form. GET /api/xm/1/subscription-forms/{subscriptionFormId}. Body fields: none. Reference: https://help.xmatters.com/xmapi/#get-a-subscription-form

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

B3.4/5.0
Behavior3/5

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

The description adds 'Body fields: none' and the HTTP method, but the read-only, idempotent, and non-destructive traits are already declared in annotations. It does not provide extra details on auth, errors, rate limits, or response behavior, though the annotations carry most of the burden.

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?

The description is a single tight sentence containing the action, resource, endpoint, body note, and a reference link. It is front-loaded with the key information and contains no filler.

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 tool is simple and the annotations cover its safety profile, so it does not need extensive explanation. However, the description does not state the return value (the subscription form object) or any prerequisites for obtaining the ID; the reference URL partially covers this but is not self-contained.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description does not explain what subscriptionFormId represents, how to obtain it, or any constraints beyond the schema's minLength. With schema description coverage at 50% and no param explanations, the description fails to compensate, and the pagination note about query parameters is embedded in the schema rather than the tool description.

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 specific verb and resource ('Get a subscription form') and gives the exact REST path, which leaves no ambiguity. The singular 'subscription form' with the required ID clearly differentiates it from the plural xmatters_get_subscription_forms and related create/modify tools.

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?

The description offers no guidance on when to use this tool versus alternatives such as xmatters_get_subscription_forms or xmatters_get_subscription_forms_in_a_plan. It does not mention that this tool is for retrieving a single form by ID, nor does it suggest any exclusion conditions.

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