Skip to main content
Glama

Update an appointment status

halaxy_update_appointment_status
DestructiveIdempotent

Writes to the live Halaxy account. Sets the patient's status on an appointment (shown in the Halaxy calendar), for example arrived, attended, confirmed or cancelled. "cancelled (no charge)" also sets the invoice to $0. For a group appointment pass patient_id to say whose status changes. PATCH /main/Appointment/{id}.

Input Schema

NameRequiredDescriptionDefault
statusYesThe new status.
patient_idNoThe patient whose status changes (needed only when the appointment has several patients).
appointment_idYesThe appointment id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Adds real context beyond the annotations: it warns that this writes to the live account and discloses a cross-resource side effect ('cancelled (no charge)' also sets the invoice to $0), which annotations alone could not convey. It leaves out error behavior and what happens on an invalid transition, so not a 5.

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?

Four compact sentences that front-load the most important fact (live account write) before the mechanics; the trailing PATCH endpoint is mildly redundant but not wasteful. No filler or tautology.

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?

Covers the essentials for a destructive live-write status mutation with no output schema: where writes land, the side effect on invoices, and the multi-patient case. The absence of any statement about the response or about invalid status transitions is the only meaningful gap.

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?

Schema coverage is 100% so the baseline is 3; the description earns an extra point by explaining the operational consequence of one enum value (invoice zeroing) and the conditional need for patient_id, which the schema field descriptions do not capture.

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?

States a specific verb and resource ('Sets the patient's status on an appointment') plus concrete example values, which makes it trivially distinguishable from sibling getters/creators like halaxy_get_appointment and halaxy_create_appointment.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a concrete conditional for the optional parameter ('For a group appointment pass patient_id to say whose status changes') and flags the special 'cancelled (no charge)' variant. It does not explicitly say when to prefer this over alternatives such as recreating or cancelling an appointment, so it stops short of full routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.