Skip to main content
MCP access is available to approved Sandbox projects.
Heyrafiki MCP exposes read-only Practitioner, Booking, Session, Benefits, Claims and remittance tools over the same resource definitions as the REST API.

Endpoint

Heyrafiki implements MCP revision 2026-07-28 over Streamable HTTP. Read the protocol specification.
The protocol is stateless. Current clients send the protocol version and capabilities with every request. New integrations should not depend on an initialize exchange or Mcp-Session-Id.

Connect

1

Add the remote server

Use the endpoint above in a client that supports MCP 2026-07-28.
2

Complete OAuth

The server returns protected-resource metadata when authorization is required. The client uses it to discover the authorization server and request the approved scopes.
3

Discover capabilities

Call server/discover, then tools/list. The available operations are determined by the authenticated Sandbox project and its scopes.
Access tokens are bound to the MCP resource, a Heyrafiki Organization and an approved grant. A token cannot use a tool outside the intersection of its token scopes and grant scopes.

Message format

Every POST includes these HTTP headers: The values in MCP-Protocol-Version, Mcp-Method and Mcp-Name must match the JSON-RPC body. A mismatch is rejected with HeaderMismatch (-32020). Every request also carries protocol metadata inside params._meta:

Discover the server

After OAuth, call server/discover before invoking a tool.
Successful results use resultType: "complete". Discovery and tool-list responses also include ttlMs and cacheScope. Treat private results as specific to the authenticated client and project.

Call a tool

Use an MCP SDK where possible. It adds the required transport headers and per-request metadata for you.

Available tools

Access boundaries

Tools are read-only. Results are limited to the authenticated Sandbox project and Organization. Every request is size-bounded, rate-limited, scoped and recorded in the MCP access audit. Request access for a Sandbox project.
Last modified on August 24, 2026