Skip to main content
Glama

List or search patients

halaxy_list_patients
Read-only

List or search patient records (demographics and contact details; HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Patient.

Input Schema

NameRequiredDescriptionDefault
idNoOne id or several separated by commas, for example 1,2,3.
nameNoSearch the family, given or preferred name (matches the start of the name).
pageNoPage number, 1-based (default 1). Use next_page from the previous reply.
sortNoSort order: _lastUpdated, name, created, -_lastUpdated, -name, -created ("-" = descending).
countNoResults per page, 1-100 (default 30).
emailNoAn email address.
givenNoStart of the given name.
phoneNoA phone number, local or E.164 (+61412345678).
familyNoStart of the family name.
statusNoPatient status, e.g. active.
createdNoCreated (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le).
includeNoAlso return related resources in "included": any of Patient:general-practitioner.
birthdateNoDate of birth (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le).
last_updatedNoOnly records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le).
general_practitionerNoA Practitioner/PractitionerRole the patient has records with.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes that this is a safe read operation. The description adds useful context beyond annotations: HEALTH DATA sensitivity, AND semantics for combining filters, paging behavior, and the GET /main/Patient endpoint. It still does not describe permissions, rate limits, or the full response envelope.

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 four short, front-loaded sentences with no wasted wording. Purpose, health-data sensitivity, filter combination, paging, and endpoint are all stated efficiently.

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?

For a 15-parameter list/search tool with no output schema, the description is largely complete: it states the purpose, the kind of records returned, health-data sensitivity, filter combination semantics, and paging. It could be slightly richer about the response envelope, but the schema documents all parameters fully and the annotations cover safety.

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 description coverage is 100%, so the baseline is 3. The description adds meaningful semantics beyond the schema by stating 'Filters combine with AND,' which is important for interpreting the 15 optional filter parameters, and by reiterating the next_page-to-page paging mapping.

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 gives a specific verb and resource: 'List or search patient records.' It also states the record content (demographics and contact details) and flags it as HEALTH DATA, making clear how it differs from sibling single-record tools like halaxy_get_patient and mutation tools like halaxy_create_patient.

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 phrase 'List or search patient records' implies the use case, and the description adds that filters combine with AND and that paging uses next_page as page. However, it does not explicitly say when to use this tool versus alternatives such as halaxy_get_patient for a single patient or halaxy_create_patient for creation.

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.