Skip to content

Scope

In scope

  • An MCP endpoint inside CiviCRM, served by the extension at civicrm/mcp. There is no separate server process.
  • OAuth 2.1 sign-in for AI clients, with identity taken from the CMS login (WordPress first; Drupal, Backdrop and Standalone are on the Roadmap).
  • Read-only built-in tools on APIv4 and SearchKit, run with permission checks on, as the signed-in user.
  • A tool registry that other extensions can add tools to by listening to an event. That way, site-specific tools live in the site's own extension, not in this one.
  • Administrator controls: who may connect, how many rows a call may return, and revoking every token at once.
  • A call log: one row for every tool call — who, which tool, the arguments sent, how many rows came back, and the outcome. See Security and permissions.

Out of scope

These are out of scope. Requests for them will be closed with a link to this section.

Item Why
A blanket permission bypass: a "service account", an admin override, or any tool that turns permission checks off The design rests on the AI acting as the person asking, so CiviCRM's own security is the ceiling. The one exception is CiviCRM's own, a SearchKit display set to bypass ACLs: see The one deliberate exception
Writes, for now Reading safely comes first. Writes are a possible later item on the Roadmap: opt-in per site and always previewed first. Until then, requests for write tools are deferred, not accepted
Hosting or proxying an AI model The extension serves data to an AI client. It does not run, pay for or choose a model
API-key authentication for outside servers Plenty of external MCP servers already do this. This extension exists to offer the signed-in, per-user alternative
Organisation-specific tools in this repository Add them from your own extension through the tool registry. See Adding your own tools
A chat interface inside CiviCRM The AI client supplies the conversation. This extension only supplies data
Guaranteed support response times This is a volunteer-maintained project. See the life-cycle statement on the About page

Changing the scope

Scope changes are proposed in an issue logged in GitLab labelled type:request. If the maintainers agree, the conclusion is written back into this page.