Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Get plan constants

xmatters_get_plan_constants
Read-onlyIdempotent

Fetch constants defined for a specific xMatters plan, enabling automated workflows to use pre-configured values.

Instructions

Get plan constants. GET /api/xm/1/plans/{planId}/constants. Body fields: none. Reference: https://help.xmatters.com/xmapi/#get-plan-constants

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
queryNoAPI query parameters; arrays are comma-joined. Documented names: offset, limit. 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
Behavior4/5

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

Annotations already indicate readOnlyHint=true, destructiveHint=false, and idempotentHint=true. The description adds the exact API endpoint and mentions that there are no body fields, reinforcing the read-only nature. This is sufficient given that annotations cover the safety profile, and the tool is a simple GET.

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 concise, with three short sentences. It front-loads the purpose and HTTP endpoint, then provides a reference link. No unnecessary fluff, though it could be slightly expanded to include return format or usage guidance.

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 relatively simple, and the description includes the endpoint and reference. However, it lacks information about return format, pagination specifics (which are partly in the schema), and any required permissions. Given the availability of an API reference link, the agent can find details if needed, but the description could be more self-contained.

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?

Schema description coverage is 50%, meaning the query parameter is documented in the schema (offset, limit, pagination behavior). The description does not add additional semantics for parameters; the path parameter (planId) is clear from its name and schema. The schema already covers query parameters well, so the description doesn't need to add more.

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 clearly states that the tool retrieves plan constants and includes the HTTP endpoint. It is distinct from related tools like xmatters_create_plan_constant and xmatters_modify_plan_constant, though it doesn't explicitly name them.

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 description provides the endpoint and hints that it is a read operation (GET), but it does not explicitly state when to use this tool versus other constant-related tools (e.g., for creating or modifying constants). The agent can infer usage from the HTTP verb and endpoint, but there's no explicit guidance on prerequisites or scenarios.

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