Skip to content

MCP reference / Notifications

Notification tools

Two tools, both scoped to the calling user's own inbox rather than the whole practice — an agent cannot read another member's notifications.

How to read this

Each tool below lists its arguments exactly as the input schema declares them — the type, whether it is required, and the permitted values where the schema fixes them. There are no argument descriptions: the schemas carry types, not prose, and inventing a sentence per argument would be writing fiction about a contract.

practiceId is never an argument. It comes from your token, and the write paths strip it if a client sends one anyway.

Every example is a complete tools/call request with this tool's required arguments filled in. Errors are returned inside a 200 response with isError set — see the MCP overview for that envelope, and the full catalogue for every tool at a glance.

Notifications

The calling user's own inbox. Not practice-wide.

list_notifications

Read-onlyAny member

List your notifications, newest first, with the unread count. Pass unreadOnly=true to skip read entries.

Arguments

ToolTypeRequired?
unreadOnlybooleanOptional
limitintegerOptional
offsetintegerOptional

Example call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_notifications",
    "arguments": {}
  }
}

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "status": 200,
      "ok": true,
      "data": { "...": "the requested records" }
    }
  }
}

Errors

CodeStatusWhen
validation_failed400An argument is missing, of the wrong type, or outside its allowed values.
unauthorized401The bearer token is missing, invalid or expired.

mark_notifications_read

WritesAny member

Mark one notification read (action=one, requires notificationId) or the whole inbox (action=all).

Arguments

ToolTypeRequired?
actionone | allRequired
notificationIdstringOptional

Example call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "mark_notifications_read",
    "arguments": {
      "action": "one"
    }
  }
}

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "status": 200,
      "ok": true,
      "data": { "...": "the written record" }
    }
  }
}

Errors

CodeStatusWhen
validation_failed400An argument is missing, of the wrong type, or outside its allowed values.
not_found404The id does not exist in your practice. A malformed id looks identical.
unauthorized401The bearer token is missing, invalid or expired.

Common questions

Patient records are encrypted in transit and at rest, files are stored privately and served through short-lived signed links, and every change is written to an audit log. Staff accounts sign in with passkeys rather than shared passwords.

Yes. Every list in HyperCRM exports to CSV from the app, and your files can be downloaded at any time. Your practice data belongs to you, and there is no export fee or waiting period — on either plan, during the trial, and after you cancel.

HyperCRM is paid software. Every practice starts with a 30-day free trial of the full Complete plan, with no card required. After that, plans start at €19 and €29 a month excluding VAT, banded by how many practitioners you have. Every price is printed on the pricing page rather than quoted on a call.