Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Get a scheduled message attachment

xmatters_get_a_scheduled_message_attachment
Read-onlyIdempotent

Retrieve a scheduled message attachment file by providing the scheduled message ID and attachment ID (file name). Returns the raw attachment bytes, including text files.

Instructions

Get a scheduled message attachment. GET /api/xm/1/scheduled-messages/{scheduledMessageId}/attachments/{attachmentId}. Returns attachment bytes, including text files; response is not a JSON object despite illustrative response code. attachmentId is a file name. Body fields: none. Reference: https://help.xmatters.com/xmapi/#get-a-scheduled-message-attachment

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

A4.3/5.0
Behavior4/5

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

Annotations already cover readOnly and idempotent behavior. The description adds valuable behavioral details beyond that: it explicitly notes that the response returns raw bytes (including text files) and is not a JSON object, which is critical for agents expecting a standard JSON response. It also clarifies that attachmentId is a filename.

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 efficient and well-structured. It opens with the core purpose, then provides the concrete endpoint and key behavioral nuances (non-JSON response, attachmentId meaning). The reference link adds utility without bloat. No redundancy or fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple GET operation with two path parameters and no output schema, the description covers all essential aspects: the endpoint, the response type, the nature of attachmentId, and the absence of a body. Combined with annotations that address safety, an agent has everything needed to invoke the tool correctly.

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?

The schema only lists path parameters without individual descriptions. The description enriches the semantics by stating that attachmentId is a file name and giving the URL pattern. This adds meaning for attachmentId, while scheduledMessageId is self-evident from its name. The query object is documented in the schema as having no documented names, and the description does not add more, but that's acceptable given the GET nature.

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 tool's function: 'Get a scheduled message attachment' and provides the exact API endpoint URL. This distinguishes it from attachment tools for other resources (events, scenarios) and leaves no ambiguity about the resource type.

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 implies usage context by naming the specific resource (scheduled message attachments), but does not explicitly contrast it with sibling tools or state when this should be used over others. The name itself differentiates, but explicit guidance is missing.

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