Skip to Content
🎉 Nextra 2.0 is released. Read more →
AI EmployeeMCP ServerHow to Use the TWIM CRM MCP Server

TABLE OF CONTENTS


What is the MCP Server?

The GoTWIM CRM MCP server is a standardized, secure protocol that allows AI agents to read and write data in GoTWIM CRM without needing SDKs or deep custom integrations. You can now give agents access to critical tools like Calendar, Contacts, Conversations, Opportunities, and Payments through a single, unified interface.

Key Benefits of Using the MCP Server

Connecting your AI agents to GoTWIM CRM has never been easier or safer.

  • Standardized Access: Query and update data through a unified protocol.
  • Fast Integration: No SDKs required; works with any HTTP-supporting client.
  • Secure: Uses private integration tokens (PITs) for granular, permission-based access.
  • Scalable: Designed for future expansion to 250+ tools.
  • Flexible: Supports popular clients like Cursor, Windsurf, and OpenAI Playground.

Top 36 Tools Available

Below is the initial set of tools your AI agents can use today:

#ToolEndpointDescription
1Get Calendar Eventscalendars_get-calendar-eventsGet calendar events using userId, groupId, or calendarId.
2Get Appointment Notescalendars_get-appointment-notesRetrieve notes for a specific appointment.
3Get All Taskscontacts_get-all-tasksRetrieve all tasks for a contact.
4Add Tagscontacts_add-tagsAdd tags to a contact.
5Remove Tagscontacts_remove-tagsRemove tags from a contact.
6Get Contactcontacts_get-contactFetch contact details.
7Update Contactcontacts_update-contactUpdate a contact.
8Upsert Contactcontacts_upsert-contactUpdate or create a contact.
9Create Contactcontacts_create-contactCreate a new contact.
10Get Contactscontacts_get-contactsFetch all contacts.
11Search Conversationconversations_search-conversationSearch/filter/sort conversations.
12Get Messagesconversations_get-messagesRetrieve messages by conversation ID.
13Send a New Messageconversations_send-a-new-messageSend a message to a conversation thread.
14Get Locationlocations_get-locationGet location details by ID.
15Get Custom Fieldslocations_get-custom-fieldsRetrieve custom field definitions for a location.
16Search Opportunityopportunities_search-opportunitySearch for opportunities by criteria.
17Get Pipelinesopportunities_get-pipelinesFetch all opportunity pipelines.
18Get Opportunityopportunities_get-opportunityFetch opportunity details by ID.
19Update Opportunityopportunities_update-opportunityUpdate opportunity details.
20Get Order by IDpayments_get-order-by-idRetrieve payment order details.
21List Transactionspayments_list-transactionsFetch paginated list of transactions.
22Check Blog URL Slugblogs_check-url-slug-existsCheck the blog slug which is needed before publishing any blog post.
23Update Blog Postblogs_update-blog-postUpdate blog post for any given blog site
24Create Blog Postblogs_create-blog-postcreate blog post for any given blog site
25Get Blog Authorsblogs_get-all-blog-authors-by-locationget blog authors for a given location ID
26Get Blog Categoriesblogs_get-all-categories-by-locationget blog categories for a given location ID
27Get Blog Posts by Blog IDblogs_get-blog-postget blog posts for any given blog site using blog ID
28Get Blogs by Locationblogs_get-blogsget blogs using Location ID
29Create Email Templateemails_create-templateCreate a new template
30Get Email Templatesemails_fetch-templateFetch email templates by location id
31Get Social Media Accountssocialmediaposting_get-accountGet list of accounts and groups
32Get Social Media Statisticssocialmediaposting_get-social-media-statisticsRetrieve analytics data for multiple social media accounts
33Create Social Media Postsocialmediaposting_create-postCreate posts for all supported platforms
34Get Social Media Postsocialmediaposting_get-postGet social media post
35Get Social Media Postssocialmediaposting_get-postsGet social media posts
36Update Social Media Postsocialmediaposting_edit-postEdit social media post

How To Set Up the MCP Server

Step 1: Configure Your Agent/Client

Add the MCP endpoint and headers to your agent configuration:

json

CopyEdit

{ "mcpServers": { "prod-ghl-mcp": { "url": "https://services.leadconnectorhq.com/mcp/", "headers": { "Authorization": "Bearer your-token>", "locationId": "sub-account-id>" } } } }

Step 2: Get Your Private Integration Token (PIT)

  1. Go to Settings → Private Integrations in your GoTWIM CRM location.
  2. Click Create New Integration.
  3. Select the required scopes (listed below).
  4. Copy and securely store your token.

Required Scopes

Make sure your PIT includes:

  • View/Edit Contacts
  • View/Edit Conversations
  • View/Edit Conversation Messages
  • View/Edit Opportunities
  • View Calendars & Calendar Events
  • View Locations
  • View Payment Orders & Transactions
  • View Custom Fields
  • View Forms
  • Check Blog Post Slug
  • Update Blog Post
  • Create Blog Post
  • View Blog Authors
  • View Blog Categories
  • blogspostsreadonly
  • blogslistreadonly
  • Create, Update and Delete Email Templates
  • View Email Templates
  • View Social Media Accounts
  • View Social Media Statistics
  • Edit Social Media Posts
  • View Social Media Posts

Step 3: Start Building!

Your agents can now call tools using natural language instructions, seamlessly translated into secure API calls via MCP.

Example Tool Call

Python example:

python

CopyEdit

import requests headers = {     "Authorization": "Bearer YOUR_PIT_TOKEN",     "locationId": "YOUR_LOCATION_ID" } data = {     "tool": "contacts_get-contact",     "input": {         "contactId": "abc123"     } } response = requests.post(     "https://services.leadconnectorhq.com/mcp/",     headers=headers,     json=data ) print(response.json())

Roadmap & Vision

The current MCP release is just the beginning. Our roadmap includes:

  • Individual MCP servers dedicated to specific services for targeted workflows.
  • npx package to support clients without native HTTP support (e.g., Claude Desktop).
  • OAuth support for advanced authorization flows.
  • Expansion to 250+ tools to create a true unified orchestrator layer for AI agents.
  • Enable complete automation of business processes across all GoTWIM CRM modules.

Frequently Asked Questions

Q: Can I use this with OpenAI Playground or Claude?  Yes! Any client supporting HTTP requests can integrate with MCP.

Q: Do I need to install an SDK?  No SDK is required — MCP uses a standard HTTP protocol.

Q: Is my data secure?  Yes. Data access is fully scoped via Private Integration Tokens and secured through HTTPS.

Q: Can I restrict what tools an agent can use?  Yes. You can control access by limiting scopes in your PIT.

Q: What if I need a new tool or endpoint?  Reach out with feedback! We’re actively expanding the available toolset.

Next Steps

  • Create your Private Integration Token and configure scopes.
  • Update your AI agent or client configuration with the MCP endpoint.
  • Start building agent-driven automations and integrations today!
  • Provide feedback to help shape future expansions and new tool support.