> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useboom.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Use MCP
> Connect Boom to Claude, Cursor, or any AI tool. Add one link, sign in: no API key.
Boom works with any AI tool that supports **MCP** (Model Context Protocol),
like Claude, Cursor, and VS Code. Once it's connected, the tool can look up and
update your customer data for you.
It takes two steps, and there's no API key to set up.
Copy this link:
```
https://www.useboom.ai/mcp
```
Then add it the way your tool expects:
Run this in your terminal:
```bash theme={null}
claude mcp add --transport http boom https://www.useboom.ai/mcp
```
Add this to `.cursor/mcp.json`, then open **Settings → MCP** and click
**Boom**:
```json theme={null}
{
"mcpServers": {
"boom": {
"url": "https://www.useboom.ai/mcp"
}
}
}
```
Add this to `.vscode/mcp.json`, then start the server from the little
button above it:
```json theme={null}
{
"servers": {
"boom": {
"type": "http",
"url": "https://www.useboom.ai/mcp"
}
}
}
```
Go to **Settings → Connectors → Add custom connector**, paste the link,
and click **Connect**.
Most tools use a file like this:
```json theme={null}
{
"mcpServers": {
"boom": {
"url": "https://www.useboom.ai/mcp"
}
}
}
```
The first time you use it, a window opens to sign in to Boom, the same login
you use for the dashboard. Approve it, and you're connected.
* Everything stays inside **your organization**.
* In more than one organization? Pick which one when you sign in.
* There's no key to copy or keep safe. Access follows your login.
## What you can do
Once connected, the AI tool gets the **same capabilities as the REST API**
(see [one uniform surface](/one-surface)):
* **Customer data**: find, add, and update **people**; record and read
**events** (like a purchase or a sign-up); manage **custom objects**,
things like orders or loans; and link records with **relationships**.
* **Segments**: the full authoring loop: discover what's filterable,
validate and preview a filter, create or update an audience, trigger an
evaluation, and page through who's in it.
* **Initiatives**: create and configure an initiative, whatever the job it
runs, link the templates it sends, drive the lifecycle (**launch**, cancel,
archive, unarchive), and read a summary of the data collected.
* **Participants**: add people to an active initiative, list them, check
one participant's status, read conversation transcripts (one participant
at a time, or every conversation in pages of up to 100), and stop their
outreach.
* **Journeys**: the full authoring loop, not just reading: open a draft, add
and connect nodes, set the trigger, validate, and publish. Catalogs tell an
agent which nodes, conditions, events, templates and variables exist, so it
can build a flow without guessing. See [journeys](/journeys).
That includes the email send step (`SEND_EMAIL`), with the templates it sends
authored through the email template tools below.
* **Drafts**: list the journey sends waiting for approval, with a preview of each, and approve or
reject them one by one, by id, or everything matching a filter. Approving sends **real messages**,
so it takes the **Owner** or **Admin** role.
MCP only, with no REST equivalent: a send held for review is waiting on a named person's
judgement, and an organization API key identifies the integration, not the person.
* **Extracted data**: define the typed fields a conversation should yield,
then read them back per participant or in aggregate. See
[extraction](/extraction).
* **WhatsApp templates**: see your WhatsApp numbers, then list, read,
and create message templates.
* **Email templates**: list, read, create and update email templates, as
builder blocks or as your own HTML. See [email templates](/email-templates).
* **Message logs**: list what you sent and what happened to each message —
delivered, failed, or blocked — with the recipient and the failure reason, so
you can clean a list or chase a non-delivery without opening conversations one
at a time. See [message logs](/message-logs).
* **Your agent's own tools**: list the HTTP tools your agent can call
mid-conversation, and create or update one — the same tools you author in
Agent Studio's **Herramientas** section. Reading the credentials and
environments they reference works too, so a tool can be built end to end
without leaving the chat. Secrets are never returned; a tool references one
by name. Requires the **Owner** or **Admin** role, and only for
organizations with Agent Studio. See [the agent](/the-agent).
Adding participants to an initiative (and launching one) sends **real
WhatsApp messages and emails to real customers**. Any connected AI tool can do it, so
check what a tool is doing before you let it run on its own. People on
your Do Not Contact list are always skipped.
What a connected tool can do follows **your role** in the organization: it
can do exactly what you could do in the dashboard, and nothing more. Starting
or stopping real outreach (launching, pausing, resuming or cancelling an
initiative, adding or stopping participants, publishing or stopping a
journey, approving drafts) takes the **Owner** or **Admin** role. See
[roles and permissions](#roles-and-permissions) below.
## Roles and permissions
Every MCP tool checks the same permission as the matching action in the app,
using the role you hold in the organization you signed in to. A tool your role
can't use returns a permission error; nothing else about the connection
changes. Your organization's Owner assigns each member's role.
| Role | Over MCP, this role can |
| - | - |
| **Owner** | Everything. |
| **Admin** | Everything, the same as the Owner. |
| **Member** | Read initiatives, journeys, segments, templates, drafts and customer data. Create and edit initiatives, journeys, segments, WhatsApp and email templates, extraction schemas and success metrics. Can't launch, pause, resume or cancel an initiative, add or stop participants, publish or stop a journey, approve drafts, change customer data, or change organization settings and your agent's tools. |
| **Developer** | Read and write customer data: people, events, custom objects and relationships, and see your data sources. Read initiatives, journeys, segments and templates, credentials and environments. Can't edit initiatives, journeys or segments, or start any outreach. |
| **Inbox Operator** | Read people, templates, initiatives and their conversations, and create WhatsApp templates. Can't change initiatives, journeys, segments or customer data. |
| **Billing Manager** | Read organization settings only. |
| **Viewer** | Read initiatives, journeys, drafts, segments, templates and customer data. Can't change anything. |
Reading or changing your agent's own tools, and changing organization context
or sending limits, takes the **Owner** or **Admin** role. A tool definition
carries the internal hosts your agent calls, so even reading the list is
limited to the people who can change it.
[API keys](/authentication) work differently: a key is not tied to a person, so any valid key can make any
call for your organization. Treat a key as full access and scope who holds it
accordingly.
## Related
How MCP tools map one-to-one onto REST endpoints.
Work with the same data over the REST API.
API keys for scripts and server-to-server calls.
Sync people and objects straight from your database.
Limits and the shared error shape.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.