Read Halaxy patients, appointments, slots and invoices; create patients, appointments and notes. For allied health and wellbeing practices that run their clinic in Halaxy and want help with scheduling and fees. Hosted by usefulapi — connect from Claude, ChatGPT, Cursor, or any MCP client.
Team and Enterprise: an Owner adds the connector for the organization first.
Run this command, then run /mcp in Claude Code to log in:
Add to Cursor or add this to ~/.cursor/mcp.json:
{
"mcpServers": {
"halaxy": {
"url": "https://halaxy.usefulapi.io/mcp"
}
}
}Add to VS Code or add this to .vscode/mcp.json:
{
"servers": {
"halaxy": {
"type": "http",
"url": "https://halaxy.usefulapi.io/mcp"
}
}
}No Add custom MCP server option? It depends on your account or workspace settings: see OpenAI's guide.
Run these commands. The second one opens the login page:
Other MCP clients (Windsurf, Cline, Zed and more): add the URL as a remote MCP server (Streamable HTTP). The client then opens the login page in your browser. Do not add an Authorization header: see Before you connect.
The AI finds appointment times in a date range for a given duration, narrowed to a practitioner or clinic, and respects your online booking preferences.
halaxy_find_available_appointments halaxy_list_practitioner_roles
The AI lists the schedules of your practitioners and their time slots, so you can see which times are open or busy this week.
halaxy_list_schedules halaxy_list_slots
The AI lists the appointment types and the fees your practice charges for, so you can check the price list in one place.
halaxy_list_healthcare_services halaxy_list_fees
The AI lists the practitioners, their roles at each clinic location and the practice group, with the ids you need for other tools.
halaxy_list_practitioners halaxy_list_practitioner_roles halaxy_list_organizations
Patient data: Do not use this server with protected health information (PHI). We do not sign HIPAA Business Associate Agreements (BAAs). See Terms, Health data.
The login page asks for your Region, Client ID and Client Secret.
Buy the API add-on under Add-ons (only the account owner can), then open Developer in Halaxy, create an API key and copy the Client ID and Client Secret (Halaxy docs). Choose UK and EU if your practice is in the UK or EU, otherwise Australia and rest of world. Your credentials are used only to call the Halaxy API on your behalf; they are never shown to anyone.
Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Region, Client ID and Client Secret. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
Turn on the Halaxy connector, then ask in plain words. The AI picks the tools.
| Tool | Type | What it does |
|---|---|---|
halaxy_list_patients | read | List or search patients List or search patient records (demographics and contact details; HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Patient. |
halaxy_list_practitioners | read | List practitioners List or search practitioners and administrators of the practice group (ids look like PR-12345). Filters combine with AND. Paged: pass next_page as page. GET /main/Practitioner. |
halaxy_list_practitioner_roles | read | List practitioner roles (clinic locations) List or search practitioner roles: a practitioner's association with one clinic location (the id used when booking and for clinical notes). Filters combine with AND. Paged: pass next_page as page. GET /main/PractitionerRole. |
halaxy_list_organizations | read | List organizations and clinics List or search the practice group, its clinic locations, funders and external practices (practice group ids look like PG-12345). Filters combine with AND. Paged: pass next_page as page. GET /main/Organization. |
halaxy_list_appointments | read | List appointments List or search appointments (HEALTH DATA: names the patient). Filters combine with AND. Paged: pass next_page as page. GET /main/Appointment. |
halaxy_list_schedules | read | List practitioner schedules List or search schedules: containers of bookable time slots per practitioner. Filters combine with AND. Paged: pass next_page as page. GET /main/Schedule. |
halaxy_list_slots | read | List time slots List or search time slots of practitioner schedules (free or busy). Filters combine with AND. Paged: pass next_page as page. GET /main/Slot. |
halaxy_list_healthcare_services | read | List appointment types List or search appointment types used by the practice group, clinics and practitioners. Filters combine with AND. Paged: pass next_page as page. GET /main/HealthcareService. |
halaxy_list_fees | read | List fees List or search fees (ChargeItemDefinition): the services and products a practice charges for. Filters combine with AND. Paged: pass next_page as page. GET /main/ChargeItemDefinition. |
halaxy_list_coverage | read | List patient coverage (claim details) List or search patients' health fund membership and claim details (HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Coverage. |
halaxy_list_invoices | read | List invoices List or search invoices of the practice group. Filters combine with AND. Paged: pass next_page as page. GET /main/Invoice. |
halaxy_list_invoice_lines | read | List invoice lines List or search invoice lines: single fees on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/InvoiceLine. |
halaxy_list_payment_transactions | read | List payment transactions List or search payment transactions recorded on invoices. Filters combine with AND. Paged: pass next_page as page. GET /main/PaymentTransaction. |
halaxy_list_referrals | read | List referrals List or search referrals from one healthcare provider to another (HEALTH DATA). Filters combine with AND. Paged: pass next_page as page. GET /main/Referral. |
halaxy_list_referral_definitions | read | List referral templates List or search referral templates with preset properties. Filters combine with AND. Paged: pass next_page as page. GET /main/ReferralDefinition. |
halaxy_get_patient | read | Get a patient Fetch a patient record (HEALTH DATA) by id. GET /main/Patient/{id}. |
halaxy_get_practitioner | read | Get a practitioner Fetch a practitioner or administrator by id. GET /main/Practitioner/{id}. |
halaxy_get_practitioner_role | read | Get a practitioner role Fetch a practitioner role at a clinic location by id. GET /main/PractitionerRole/{id}. |
halaxy_get_organization | read | Get an organization Fetch a practice group, clinic, funder or external practice by id. GET /main/Organization/{id}. |
halaxy_get_appointment | read | Get an appointment Fetch an appointment with its participants and statuses (HEALTH DATA) by id. GET /main/Appointment/{id}. |
halaxy_get_schedule | read | Get a schedule Fetch a practitioner schedule by id. GET /main/Schedule/{id}. |
halaxy_get_slot | read | Get a time slot Fetch a time slot by id. GET /main/Slot/{id}. |
halaxy_get_healthcare_service | read | Get an appointment type Fetch an appointment type by id. GET /main/HealthcareService/{id}. |
halaxy_get_fee | read | Get a fee Fetch a fee (ChargeItemDefinition) by id. GET /main/ChargeItemDefinition/{id}. |
halaxy_get_coverage | read | Get patient coverage Fetch a patient's coverage (claim details) record by id. GET /main/Coverage/{id}. |
halaxy_get_invoice | read | Get an invoice Fetch an invoice by id. GET /main/Invoice/{id}. |
halaxy_get_invoice_line | read | Get an invoice line Fetch an invoice line by id. GET /main/InvoiceLine/{id}. |
halaxy_get_payment_transaction | read | Get a payment transaction Fetch a payment transaction by id. GET /main/PaymentTransaction/{id}. |
halaxy_get_referral | read | Get a referral Fetch a referral (HEALTH DATA) by id. GET /main/Referral/{id}. |
halaxy_get_referral_definition | read | Get a referral template Fetch a referral template by id. GET /main/ReferralDefinition/{id}. |
halaxy_find_available_appointments | read | Find available appointment times Find free appointment times between start and end for a given duration, respecting each practitioner's online booking preferences (buffer time, lead time, advance booking limit). Narrow it with practitioner, practitioner_role or organization. GET /main/Appointment/$find. |
halaxy_create_patient | write | Create a patient Writes to the live Halaxy account. Creates a new patient record (always a new one: search with halaxy_list_patients first to avoid a duplicate). Pass managing_organization (the practice group id, e.g. PG-12345, from halaxy_list_organizations) if Halaxy asks for it. POST /main/Patient. |
halaxy_create_appointment | write | Book an appointment Writes to the live Halaxy account. Books an appointment for a patient with a practitioner at a clinic (the practitioner role). Halaxy also creates the invoice, clinical note and reminder. Use halaxy_find_available_appointments for free times. By default a double booking is refused (HTTP 409, nothing created). POST /main/Appointment/$book. |
halaxy_update_appointment_status | write | Update an appointment status 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}. |
halaxy_create_clinical_note | write | Create a draft clinical note Writes to the live Halaxy account. Adds a clinical note to a patient's record as a DRAFT (preliminary); the practitioner reviews and publishes it in Halaxy. The author is a PractitionerRole (practitioner at a clinic). Only HTML text is supported. POST /main/DocumentReference. |
halaxy_usage_status | Usage status (free-tier meter) Report the caller's current usage: the plan, calls used this month, the limit of the plan (the free monthly cap or the Pro fair use limit), remaining, and whether the limit is reached. Read-only; does not count against the meter. | |
halaxy_request_feature | Request a missing feature Tell usefulapi that the user needs something the Halaxy tools cannot do yet (a missing tool, field or filter). Call it only when the user asks for something none of the tools can do, and tell the user that you send the request. Do not call it for errors or for normal requests. Do not include personal data, credentials or customer records. Stored with the product name and the client type (for example Claude or Cursor), without the user's account. At most 5 requests per day. Does not count against the meter. | |
halaxy_upgrade | Upgrade to Pro (unlimited*) Get Pro: unlimited tool calls (fair use limit: 10,000 a month) on Halaxy (the free tier caps monthly usage). Plans: "monthly" — $9/month; "yearly" — $90/year (2 months free). Cancel any time: Pro then runs to the end of the paid period, so it also suits a one-time job. *A fair use limit applies. For heavy use (near Pro's limit): "plus" or "plus_yearly" — Pro+, $39/month or $390/year, unlimited tool calls (fair use limit: 100,000 a month); an existing Pro subscription changes to Pro+ in place (needs confirm: true; the price difference for the rest of the period is charged at once). Otherwise returns a short link to open in your browser (it opens Stripe Checkout); after payment the account upgrades automatically. Does not count against the meter. | |
halaxy_cancel_subscription | Cancel the Pro subscription Cancel the caller's Halaxy Pro subscription at the end of the paid period (no refund for the current period; Pro continues until then, then the free tier applies). Requires confirm: true. Run halaxy_upgrade later to undo the cancel before the period ends. Does not count against the meter. |
| Plan | Price | Limit |
|---|---|---|
| Free | $0 | 50 tool calls / month |
| Proper account | $9/mo · $90/yr | Unlimited* |
*Pro fair use limit: 10,000 tool calls a month on this server. For more, write to [email protected].
Pro covers this Halaxy server only. Subscribe with halaxy_upgrade (it returns a Stripe Checkout link). Cancel any time with halaxy_cancel_subscription: Pro continues to the end of the paid period, with no refund for the current period, and running halaxy_upgrade before then undoes the cancel. Or write to [email protected].
Find open appointment times. Browse schedules and time slots. List your appointment types and fees. See your practitioners and clinics. See what you can do for the details.
No. usefulapi is an independent service. It is not affiliated with or endorsed by Halaxy. The server calls the Halaxy API with your own Halaxy access, so it sees only the data that your account can see.
No. Do not use this server with protected health information (PHI). We do not sign HIPAA Business Associate Agreements (BAAs). See Terms, Health data.
Yes. In Claude, add this server's URL as a custom connector. In ChatGPT, add it as a custom MCP server in Plugins. Then log in once. Cursor, VS Code, Claude Code and Codex work too. See the setup steps.
The login page asks for your Region, Client ID and Client Secret. See Before you connect for where to find them.
No. Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Region, Client ID and Client Secret. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
The login stores them encrypted in the authorization grant of your connection. The server uses them to call the Halaxy API for you and to derive a private account id for usage metering. usefulapi does not show them on any page or in any reply. To stop all access, remove the connector and change or delete these credentials in Halaxy.
Yes, if you approve it. 4 of the 35 Halaxy tools can create or change data. The other 31 are marked read-only. Most MCP clients ask you to approve a tool call before it runs.
The Free plan gives 50 tool calls / month. Pro costs $9/mo or $90/yr, with unlimited tool calls (fair use limit: 10,000 tool calls a month), for this Halaxy server only. Cancel any time: Pro then runs to the end of the paid period. Run halaxy_usage_status to see how many calls you used.
Ask the AI to run halaxy_upgrade: it returns a Stripe Checkout link. To cancel, run halaxy_cancel_subscription. Pro continues to the end of the paid period.
Tell the AI what you wanted to do. It can send the request with halaxy_request_feature. We store the text with the server name, the type of AI client and the tool you tried, not with your account, and read every request when we plan new tools. You can send up to 5 requests per day.
Any client that supports remote MCP servers (Streamable HTTP) with OAuth login: Claude (web and desktop), Claude Code, ChatGPT, Codex, Cursor, VS Code, Windsurf and others.
This is a Model Context Protocol endpoint — meant to be connected from an AI client, not opened in a browser. An invalid_token response at the URL is the auth gate working as designed; clients authenticate automatically.