Skip to main content
Glama

List appointments

halaxy_list_appointments
Read-only

List or search appointments (HEALTH DATA: names the patient). Filters combine with AND. Paged: pass next_page as page. GET /main/Appointment.

Input Schema

NameRequiredDescriptionDefault
idNoOne id or several separated by commas, for example 1,2,3.
dateNoAppointment date/time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le).
pageNoPage number, 1-based (default 1). Use next_page from the previous reply.
sortNoSort order: date, -date ("-" = descending).
countNoResults per page, 1-100 (default 30).
createdNoCreated (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le).
includeNoAlso return related resources in "included": any of Appointment:patient, Appointment:practitioner-role.
patientNoPatient id.
part_statusNoThe patient's participation status, e.g. booked, arrived, cancelled.
last_updatedNoOnly records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le).
organizationNoThe clinic (Organization) id including its prefix.
practitionerNoPractitioner id, e.g. PR-123.
include_iterateNoAlso return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization.
practitioner_roleNoPractitionerRole id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations only say readOnlyHint=true, so the description's additions matter: filters combine with AND, the result set is paged and you pass next_page as page, and the call returns PHI (patient names). That last point is real operational context an agent should know before logging or echoing output.

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 short clauses, front-loaded with purpose, followed by the combining rule, pagination, and the data-sensitivity warning. The trailing "GET /main/Appointment" is a raw endpoint fragment of marginal value but costs little.

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 14-parameter search tool with no output schema, the description covers filtering and paging behavior but never describes the response shape — in particular the "included" block produced by include/include_iterate, which is the least self-evident part of the return. Adequate, but an agent must infer result structure from the schema alone.

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 100%, so every one of the 14 parameters is already documented, including the page/next_page relationship the description restates. The description adds only the cross-parameter AND semantics, which is a small but genuine increment over per-field docs.

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?

"List or search appointments" names a specific verb and resource, which cleanly separates it from halaxy_get_appointment, halaxy_create_appointment, and halaxy_find_available_appointments. It stops short of naming those siblings explicitly, so the differentiation is inferable rather than stated.

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 the read/search use case but gives no explicit when-to-use or when-not-to-use guidance — notably it never says how this differs from halaxy_find_available_appointments (availability search) or halaxy_get_appointment (single-record fetch). Usage is implied by the verb only.

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.