Skip to main content
Glama
robertsmieja

xmatters-mcp

by robertsmieja

Modify a form response option

xmatters_modify_a_form_response_option
Destructive

Update an existing form response option's fields, such as text, prompt, action, or redirect URL, to control how recipients respond.

Instructions

Modify a form response option. POST /api/xm/1/forms/{formId}/response-options. Body fields: id, number, text, description, prompt, action, contribution, joinConference, allowComments, redirectUrl, translations. Reference: https://help.xmatters.com/xmapi/#modify-a-form-response-option Requires operator write opt-in and confirm:true; may notify recipients or change tenant data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesComplete API JSON payload (including nested fields). See https://help.xmatters.com/xmapi/#modify-a-form-response-option
pathYes
queryNoAPI query parameters; arrays are comma-joined. Documented names: none. Pagination is explicit using offset and limit; results are not automatically combined.
confirmYesExplicit approval of this exact mutation. Operator must also enable XMATTERS_ALLOW_WRITES.

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 flag destructiveHint and non-readonly. The description adds that it requires operator write opt-in and confirm:true, and may notify recipients or change tenant data, providing useful side-effect context beyond the flags. No contradiction with annotations.

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 front-loaded with a clear purpose, then lists the endpoint, body fields, reference, and requirements. It's efficient and relevant, though the field list and URL add length; all content earns its place.

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?

Given the complexity (mutation with nested body, confirm requirement, side effects), the description covers key aspects: endpoint, body fields, reference, and safety requirements. It doesn't explain return format (no output schema) or how to obtain formId, but these are inferable from schema and context.

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 provides descriptions for body, query, and confirm, but not for path. The description enriches the body parameter by listing expected fields (id, number, text, etc.), helping construct the payload. It also reiterates the confirm requirement, adding value beyond the schema.

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 the action (modify) and the resource (form response option), and includes the exact HTTP endpoint for precision. It is specific enough to distinguish from other modify tools, though it doesn't explicitly contrast with siblings like create_form_response_options or modify_a_plan_form.

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 on when to use this tool versus alternatives, such as when to create vs modify, or how it differs from other modify tools. It only mentions requirements (confirm:true) but no use-case or exclusion criteria.

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