> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onboardme.app/llms.txt
> Use this file to discover all available pages before exploring further.

# OnboardMe MCP server

> Connect Claude, ChatGPT, Cursor and other AI assistants to an OnboardMe practice through the Model Context Protocol.

The OnboardMe MCP server lets an AI assistant work with a practice's OnboardMe data. Users can ask the assistant to find a client, check an onboarding, update a proposal, or summarise debtors, and the assistant uses OnboardMe tools to do it.

The server uses the [Model Context Protocol](https://modelcontextprotocol.io) over Streamable HTTP. Every tool calls the [Partner API](/introduction), so the MCP server never has more access than the API. Practice data is handled the same way as it is for any other API integration.

## Before you connect

<Steps>
  <Step title="Find the practice's region">
    Each practice is hosted in one region, and each region has its own MCP server. See [Regions](/mcp/regions).
  </Step>

  <Step title="Choose how to sign in">
    Most assistants use **Sign in with OnboardMe** (OAuth), where a staff member signs in and chooses Read-only or Read & write access. Server-to-server tools can use a practice API key instead. See [Authentication and permissions](/mcp/authentication).
  </Step>

  <Step title="Add the server to your assistant">
    Follow the steps for your client in [Connect a client](/mcp/connect).
  </Step>
</Steps>

## Server URLs

| Region | MCP server URL |
| - | - |
| Australia & New Zealand | `https://anzmcp.onboardme.app/mcp` |
| United Kingdom | `https://ukmcp.onboardme.app/mcp` |
| South Africa | `https://zamcp.onboardme.app/mcp` |

<Warning>
  Use the server for the practice's region. A server in another region cannot sign you in to the practice or see its data.
</Warning>

## What the assistant can do

The server has tools for clients, contacts, leads, deals, onboardings, proposals, eForms, identity verification and AML, bills, payments, statements, debtors, recurring billing, users and webhooks. See [Tools](/mcp/tools) for the full list.

<CardGroup cols={2}>
  <Card title="Regions" icon="globe" href="/mcp/regions">
    Which server to use, and how regions affect sign-in.
  </Card>

  <Card title="Connect a client" icon="plug" href="/mcp/connect">
    Claude, ChatGPT, Claude Code and Cursor.
  </Card>

  <Card title="Authentication and permissions" icon="lock" href="/mcp/authentication">
    OAuth, API keys, scopes and roles.
  </Card>

  <Card title="Tools" icon="wrench" href="/mcp/tools">
    Every tool, grouped by area.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.