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, the permitted values where the schema fixes them, and what the schema says the argument means. None of it is written here. An amount in cents, a default that applies when a field is left out, which action needs which id: those sentences come from the tool itself.

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

A tool that writes shows one example per action, because what an action needs is not what the input schema marks required: the schema requires action and leaves the rest to the action. Every example is a complete tools/call request whose arguments are checked, when this page is built, against the same object the handler parses. Errors come back inside a 200 response with isError set: the MCP overview has that envelope, and the full catalogue lists 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?What it means
unreadOnlybooleanOptionalReturn only entries the user has not read yet.
limitintegerOptionalHow many notifications to return. Defaults to 20; at most 100 (a larger value is lowered to it, not rejected).
offsetintegerOptionalHow many notifications to skip, for paging back through the inbox. At most 100000.

Example call

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

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": { "...": "the requested records" },
    "content": [{ "type": "text", "text": "<the same JSON>" }]
  }
}

Errors

CodeStatusWhen
validation_failed400An argument is missing, of the wrong type, or outside its allowed values.
plan_feature_required403The practice's plan does not include this. MCP needs Complete.

mark_notifications_read

WritesAny member

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

Arguments

ToolTypeRequired?What it means
actionstring: one | allRequired
notificationIdstringOptionalThe notification to mark read. Required for action=one; ignored for action=all.

Example call

action=one

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "mark_notifications_read",
    "arguments": {
      "action": "one",
      "notificationId": "697a8b9c-c7d8-491a-d5e6-f708192a3b4c"
    }
  }
}

action=all

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

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": { "...": "the written record" },
    "content": [{ "type": "text", "text": "<the same JSON>" }]
  }
}

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.
plan_feature_required403The practice's plan does not include this. MCP needs Complete.

Common questions

Patient records are encrypted, both where they are stored and on their way to your screen. Files are private, and a link to one stops working after a short time. Changes to patient records are recorded, with who made them and when. There is no shared practice password: everyone has their own account. On the Complete plan, the practice owner can also require two-step sign-in for the whole team.

Yes. The practice owner can export the patient list, the reports and the activity log to a spreadsheet file (CSV) from the app, and anyone in the practice can download its files at any time. Your practice data belongs to you, and there is no export fee or waiting period. That holds 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 Complete plan, with no card needed. After that, Essential starts at €19 a month and Complete at €34, VAT included. The price depends on how many practitioners you have. Every price is on the pricing page, so you never need a sales call.