Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Get subscription share permissions

xmatters_get_subscription_share_permissions
Read-onlyIdempotent

Retrieve share permissions for a subscription by ID, showing who can access or manage the subscription's sharing settings.

Instructions

Get subscription share permissions. GET /api/xm/1/subscriptions/{subscriptionId}/share-permissions. The table calls the subscription path identifier id and labels it QUERY PARAMETERS; the definition uses subscriptionId in the path. See C06. Body fields: none. Reference: https://help.xmatters.com/xmapi/#get-subscription-share-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

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, which the description does not contradict. The description adds the endpoint and notes 'Body fields: none', which is useful. However, it does not disclose any additional behaviors beyond what annotations cover, so it adds modest value.

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 three short sentences with no filler, front-loading the purpose and providing the endpoint, a naming note, and a reference. It is efficiently structured and every sentence earns its place.

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?

For a simple GET, the description provides the endpoint and a reference, but it does not describe the response format, which is relevant since there is no output schema. The cryptic 'See C06' note is not self-explanatory. Overall, it is adequate but leaves some gaps about the return value.

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 schema documents the path parameter (subscriptionId) and notes that query parameters are undocumented, while the description only adds 'Body fields: none'. With schema coverage at 50%, the description should compensate for the undocumented query parameters, but it does not explain them or even mention pagination. The description adds minimal meaning beyond 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 clearly states the action (get) and resource (subscription share permissions) and provides the exact endpoint, which is specific and not a tautology. The name and title also differentiate it from the setter sibling (xmatters_set_subscription_share_permissions), so the agent can easily identify this as the read operation.

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 use this tool versus alternatives, no prerequisites, and no exclusions. The description only gives the endpoint and a reference, with the cryptic 'See C06' providing no practical context. The agent is left to infer that this is the read counterpart of the setter.

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