Working with the Abilities API (MCP)

Groundhogg supports the WordPress Abilities API, a standard way of registering discrete, well-defined actions and queries that other systems, including AI agents and MCP (Model Context Protocol) clients like Claude, ChatGPT, or a custom assistant your team builds, can call against your CRM. Instead of screen-scraping the admin or hand-rolling a one-off integration, an agent calls the same actions Groundhogg already uses internally, through a supported and permission-checked interface.

What is the Abilities API?

The Abilities API is a WordPress-level API for registering “abilities”, individual, named operations such as finding a contact, scheduling a broadcast, or adding a contact to a flow. Each ability declares what input it expects and what it returns, which makes it straightforward for an AI agent to discover what’s available and call it correctly.

Every ability Groundhogg registers runs through the same capability and per-object permission checks as the rest of the plugin. An agent connected as a given WordPress user can only ever do what that user is already allowed to do in the CRM. Nothing more.

What Can an Agent Do?

Once connected, an agent can work across several areas of the CRM:

• Contacts: find, create, and update contacts, search your database, read and add notes, and list tags, owners, custom fields, and saved searches.
• Email and broadcasts: list saved emails and sender profiles, send a saved or one-off email to specific contacts, schedule a broadcast to a segment, and read back its open and click report.
• Flows: list your flows and add a single contact or an entire segment to one, so an agent can kick off the right automation on your behalf.

This list will grow as more abilities are added, so ask your agent to list what it can currently do for the complete, up to date set.

Setting Up MCP Access

1. Install and activate an MCP server plugin on your site, such as the MCP Adapter. This plugin is what exposes registered abilities over the MCP protocol.
2. No additional configuration is needed inside Groundhogg itself. Its abilities are registered automatically and become discoverable as soon as an MCP server plugin is active.
3. Connect your AI client to your site’s MCP endpoint using a WordPress user account, authenticating the same way you would for the REST API. An Application Password is the recommended method. The agent will run with that user’s normal permissions.
4. Confirm access by asking the agent to do something simple, like listing contacts or flows. If it tries something the connected user isn’t allowed to do, Groundhogg will refuse the request rather than erroring out.

Exploring Available Abilities

The easiest way to see what your agent can currently do is to just ask it. Try something like “what Groundhogg abilities are available to you” or “what can you do in my CRM” and it will list everything it can call right now.

We’re actively building out new abilities as part of our push to make Groundhogg the most agent friendly CRM, so the set available will keep changing over the coming months. Asking your agent directly will always give you the current, complete list.

Contacts

Name	Description
Get Contact	Retrieve a Groundhogg contact by ID.
Create Contact	Create a new contact. If a contact with the given email already exists, it is updated instead of creating a duplicate.
Update Contact	Update an existing contact by ID. Only the fields you pass are changed. Errors if no contact matches the ID.
Search Contacts	Search and list Groundhogg contacts, with pagination and segment filters.
List Owners	List the WordPress users who can be assigned as a contact owner.
Add Contact Note	Add a note to a contact. Each call creates a new note.
List Contact Notes	List the notes on a contact, most recent first.

Custom Fields & Segmentation

Name	Description
List Custom Fields	List the custom field definitions configured for contacts, mapped to their group/tab.
Add Custom Field	Create a new contact custom field definition.
Update Custom Field	Update an existing contact custom field definition by id.
List Saved Searches	List the saved contact searches (Contacts > Saved Searches in the admin).
List Tags	List the tags defined in Groundhogg.
Create Tag	Create a new Groundhogg tag, or return the existing one if the name matches.

Campaigns

Name	Description
List Campaigns	List the campaigns defined in Groundhogg.
Create Campaign	Create a new Groundhogg campaign, or return/update the existing one if the name matches.
Associate Campaign	Attach or detach a campaign from an existing flow, email, or broadcast.

Emails

Name	Description
List Email Templates	List saved Groundhogg emails, with pagination.
Get Email Template	Retrieve one saved email by ID, including full HTML and plain-text body.
Create Email Template	Create a new saved Groundhogg email (subject + HTML body).
Update Email Template	Update an existing saved email. Only provided fields are changed.
List Sender Profiles	List the valid “from” name / email combinations the site can send as.
List Replacement Codes	List the merge tags available on this site (e.g. {first}, {email}).
Send Composed Email	Send a one-off email with subject/body supplied directly; bypasses marketing-consent checks.
Send Email Template	Send an existing saved email to one or more contacts through the normal event queue.

Broadcasts

Name	Description
Send Email Broadcast	Schedule a one-off email broadcast to a segment of contacts (or send it now).
List Broadcasts	List broadcasts, most recent first, filterable by status or send-time range.
Get Broadcast	Retrieve one broadcast by ID, including its full stats report.
Cancel Broadcast	Cancel a scheduled or sending broadcast.

Flows (Funnels)

Name	Description
List Flows	List Groundhogg flows, most recently updated first.
List Step Types	List the flow/funnel step types available on this site.
Create Flow	Create a new flow with its full sequence of steps, including branching logic.
Activate Flow	Activate a flow so contacts can enter it.
Deactivate Flow	Deactivate a flow, pausing waiting events and new entries.
Add To Flow	Add a contact, or a segment of contacts, to an active flow.

Reporting & Data

Name	Description
List Report Types	List the report IDs available for pulling reports.
Get Reports	Pull data for one or more built-in and/or custom reports.
Describe Table	List the tables that can be queried, or describe one table’s columns.
Query Table	Run a read-only, filtered query against a Groundhogg database table.

Media

Name	Description
Upload Media	Upload a file (e.g. an image) into the WordPress Media Library from base64 data.

Licensing & Extensions

Name	Description
Activate License	Activate a Groundhogg license key for this site.
Check License	Check the status of a license, or every registered license if none is given.
List Extensions	List Groundhogg’s official add-on extensions and their install/license status.
Install Extension	Remotely install and activate an official add-on extension.

Settings

Name	Description
List Settings	List Groundhogg settings available to abilities, with type, allowed values, and current value.
Update Settings	Update one or more Groundhogg settings by id.

Superlinks (Pro)

Name	Description
Create Superlink	Create a trackable redirect link that applies/removes tags and edits custom fields on click.
List Superlinks	List Groundhogg Pro superlinks, with pagination.
Update Superlink	Update an existing superlink. Every field is optional.
Get Superlink	Retrieve one superlink by ID.

Skills

If you’re using Claude, you can install these skills so it already knows the right way to work with Groundhogg abilities, without you having to explain the details every time. We’ll keep updating this list and adding more skills as we get feedback from users.

To install a skill, download its .zip below and add it to Claude (in Claude Code or the Claude desktop app, add it under Settings → Capabilities → Skills, or drop it into your project’s skills folder). Once it’s installed, just describe what you want in plain language, Claude will use the skill automatically whenever it applies.