EngageBay MCP
EngageBay MCP Server
Connect an AI tool to your EngageBay account and let it search, count, read, create and update your CRM data in plain language, using 19 tools.
On this page
Implementation overview
The EngageBay MCP server lets your AI assistant answer questions about your CRM. It provides 19 tools for finding, counting and reading records, for creating and updating them, and for reading account details. Your assistant chooses the right tool for each question, so you do not call them yourself.
Supported data and permissions
What your assistant can read and change depends on the tools above and on the permissions granted to your connection.
Read access
Six record types can be searched, counted and fetched: contacts, companies, deals, products, tasks and appointments. Several tools also read supporting account data.
Contacts
Read & writePeople and leads, with the notes recorded on them.
- crm.contacts.read
- crm.contacts.write
Dedicated tools
Companies
Read & writeOrganizations and accounts in your CRM.
- crm.companies.read
- crm.companies.write
Dedicated tools
Deals
Read & writeDeals in every pipeline, including the products attached to them.
- crm.deals.read
- crm.deals.write
Dedicated tools
Products
ReadProducts that can be attached to deals. Read only — products cannot be created or updated.
- crm.deals.read
Dedicated tools
Tasks
Read & writeTasks and their owners and due dates.
- crm.tasks.read
- crm.tasks.write
Appointments
Read & writeAppointments and meetings, with their start and end times. The object type is calendar_event.
- crm.appointments.read
- crm.appointments.write
Supporting data
Account settings
ReadCompany name, website, timezone, currency and clock format.
- account.read
Dedicated tools
Account users
ReadEveryone on the account with id, name, email and role.
- account.users.read
Dedicated tools
Pipelines and stages
ReadEvery deal pipeline and its ordered stages, with ids.
- crm.deals.read
Dedicated tools
Tags
ReadTags by prefix, with how many contacts carry each.
- crm.contacts.read
Dedicated tools
Contact lists
ReadSaved contact lists and their sizes.
- crm.contacts.read
Dedicated tools
Fields and properties
ReadField keys, types and allowed values, including custom fields.
- Per object type
Dedicated tools
Write access
Five record types can be created and updated: contacts, companies, deals, tasks and appointments. Products are read only. A write needs the matching write permission for that record type — crm.contacts.write for contacts, crm.deals.write for deals, and so on.
There is no delete.
The EngageBay MCP server creates records and updates existing ones. It cannot delete anything in your account — no tool removes a record, and no permission grants deletion.
That holds for wildcard permissions too. crm.contacts.*, crm.* and * grant read, create and update only. There is also no account write permission of any kind: account.read and account.users.read are read-only.
What you can set on tasks and appointments
| Record type | Fields you can set | Notes |
|---|---|---|
| Task | name description status type priority due_at reminder_at | name is required when you create a task. status, type and priority accept only the values configured in your own account settings, so they are not a fixed list — check yours with get_properties. is_due and completed_at are derived by EngageBay and cannot be set. |
| Appointment | name starts_at ends_at | Both times are required when you create an appointment, and ends_at must be after starts_at. Tasks and appointments cannot be tagged. The owner is set with set_owner, not as a field. |
Tasks and appointments attach to contacts, companies and deals with manage_associations, not as a field on the record itself.
Permissions and scopes
Access is checked per record type, using the scopes your connection was granted. You review these on the consent screen when you connect.
| Permission | Grants | Tools |
|---|---|---|
crm.contacts.read | Read contacts, plus tags, contact lists, notes and field definitions | search_crm_objects count_crm_objects get_crm_objects search_contacts list_object_notes list_contact_lists list_tags get_properties |
crm.contacts.write | Create and update contacts | create_crm_objects update_crm_objects manage_tags set_owner manage_associations create_note |
crm.companies.read | Read companies, plus notes and field definitions | search_crm_objects count_crm_objects get_crm_objects search_companies list_object_notes get_properties |
crm.companies.write | Create and update companies | create_crm_objects update_crm_objects manage_tags set_owner manage_associations create_note |
crm.deals.read | Read deals and products, plus pipelines, notes and field definitions | search_crm_objects count_crm_objects get_crm_objects find_deals_by_product list_pipelines list_object_notes get_properties |
crm.deals.write | Create and update deals. Products stay read only — they cannot be created or updated. | create_crm_objects update_crm_objects manage_tags set_owner manage_associations create_note |
crm.tasks.read | Read tasks | search_crm_objects count_crm_objects get_crm_objects |
crm.tasks.write | Create and update tasks | create_crm_objects update_crm_objects set_owner manage_associations |
crm.appointments.read | Read appointments | search_crm_objects count_crm_objects get_crm_objects |
crm.appointments.write | Create and update appointments | create_crm_objects update_crm_objects set_owner manage_associations |
account.read | Read basic account information | get_account_info |
account.users.read | Read the list of users on the account | list_users |
Less access is handled gracefully. If your connection wasn’t granted the permission for a record type, the tool returns a clear refusal naming the missing permission, not an empty result that looks like a real answer.
Counts and searches only include records you have permission to see. If your access is scoped to specific owners or teams in EngageBay, results reflect that scope, not the account-wide total.
Available tools
Select a tool to see its parameters, examples, limits and troubleshooting. Permission shown as “per object type” means the read or write permission for the record type you are working with.
Search and retrieve 6
| Tool | What it does | Permission |
|---|---|---|
search_crm_objects | Find the records that match a specific condition — contacts, companies, deals, products, tasks, or appointments — using precise filters rather than a free-text guess. This is the tool your assistant reaches for on almost any “which records…” question. | Per object type |
count_crm_objects | Get an exact count of the records that match a filter — contacts, companies, deals, products, tasks, or appointments — without pulling back the records themselves. This is the tool for every “how many…” question. | Per object type |
get_crm_objects | Fetch full, current detail on specific records — up to 50 in one call — once you already know their ids or a contact's email address. This is the tool for “tell me everything about this record,” not for finding records in the first place. | Per object type |
search_contacts | Find contacts with a free-text keyword — a name, an email, a phone number, or a fragment of one — when you don't have a structured condition to filter on, just something you remember about the person. | crm.contacts.read |
search_companies | Find companies with a free-text keyword — a name, a website, an email domain, or a fragment of one — when you don't have a structured condition to filter on, just something you remember about the company. | crm.companies.read |
find_deals_by_product | Find every deal that includes a specific product — for questions like “which deals include the Starter Plan?” that a regular record filter can't answer directly. | crm.deals.read |
Notes 1
| Tool | What it does | Permission |
|---|---|---|
list_object_notes | Read the notes recorded against one record — a contact, company or deal — newest first, what your team wrote by hand. | Per object type |
Account metadata 5
| Tool | What it does | Permission |
|---|---|---|
get_account_info | Get your account's company name, website, timezone, currency, and clock format — the context that makes phrases like “today” or “closing this week” resolve to the right dates. | account.read |
list_contact_lists | See every contact list on the account and how many contacts are in each — a saved grouping of contacts, distinct from a tag. | crm.contacts.read |
list_pipelines | Get every deal pipeline and its stages, in order — the lookup that makes stage-based deal filters actually work, since stage names repeat across pipelines but ids don't. | crm.deals.read |
list_tags | Look up tags by prefix, with how many contacts carry each one — the way to confirm exact spelling before filtering, since tag matches are exact and case-sensitive. | crm.contacts.read |
list_users | Get the id, name, email, and role for everyone on the account — the step that turns a person's name into the owner id a filter actually needs. | account.users.read |
Schema and discovery 1
| Tool | What it does | Permission |
|---|---|---|
get_properties | Look up the exact field names, data types, and allowed values for any EngageBay record type — including your own custom fields — before you search, filter, or ask your assistant a question that depends on a specific field. | Per object type |
Create and update 6
| Tool | What it does | Permission |
|---|---|---|
create_crm_objects | Create new records — contacts, companies, deals, tasks or appointments — up to 50 in one call. Products cannot be created. | Per object type |
update_crm_objects | Update fields on records that already exist — contacts, companies, deals, tasks or appointments — up to 50 in one call. Products cannot be updated. | Per object type |
manage_associations | Link and unlink records: attach a task or an appointment to a contact, a company or a deal, or remove that link. | Per object type |
manage_tags | Add and remove tags on contacts, companies and deals. Tasks and appointments cannot be tagged. | Per object type |
set_owner | Set which user on your account owns a record. | Per object type |
create_note | Add a note to a contact, a company or a deal. | Per object type |
None of these tools deletes anything. They create records and change records that already exist. Removing a record is not something the EngageBay MCP server can do, whatever permissions you grant it.
How the tools work together
Most questions use more than one tool. Your assistant chains them automatically, but it helps to know what happens behind the scenes.
Resolve names to ids
Filters match ids, never names. list_users turns a person into an owner id, list_pipelines gives the pipeline id a stage filter needs as track_id, and list_tags confirms exact, case-sensitive tag spelling.
Example: “How many tasks are overdue for Priya?”
Check field keys first
get_properties returns each field’s key, label, type, allowed options and whether it is filterable. Filters use keys, not the labels you see in the app.
Example: “Do we have a custom field for renewal date on deals?”
Find, count or fetch
search_crm_objects finds records (up to 50 per page, no total). count_crm_objects returns an exact count with the same filters. get_crm_objects reads full, current detail for up to 50 ids.
Example: “How many deals are at Negotiation in the Sales pipeline?”
Get the time context
Every timestamp is in UTC. get_account_info returns the account timezone so phrases like “today” or “last week” resolve to the right dates.
Example: “How many contacts did we add today?”
Example prompts
Ask questions like these once you are connected.
Which deals in the Sales pipeline are still at Negotiation?
Usessearch_crm_objectsHow many contacts did we add last week?
Usescount_crm_objectsShow me the contact with email [email protected] and the notes on them.
Usesget_crm_objectsAdd a follow-up task for Priya, due Friday.
Usescreate_crm_objectsWhich deals include the Starter Plan product?
Usesfind_deals_by_productHow many tasks are overdue for Priya?
Usescount_crm_objectsConnect a client
Choose your AI tool for setup instructions. When you sign in, review the consent screen to see the permissions your connection is granted.
Ready to connect your AI tools to EngageBay?
Create a free account, pick your AI tool and start asking questions about your CRM.