How to integrate Gosquared MCP with CrewAI

Trusted by
AWS
Glean
Zoom
Airtable

30 min · no commitment · see it on your stack

Gosquared logo
CrewAI logo
divider

Introduction

This guide walks you through connecting Gosquared to CrewAI using the Composio tool router. By the end, you'll have a working Gosquared agent that can list all websites linked to your account, show active chat conversations from today, add a new shared user by email through natural language commands.

This guide will help you understand how to give your CrewAI agent real control over a Gosquared account through Composio's Gosquared MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Gosquared with

TL;DR

Here's what you'll learn:
  • Get a Composio API key and configure your Gosquared connection
  • Set up CrewAI with an MCP enabled agent
  • Create a Tool Router session or standalone MCP server for Gosquared
  • Build a conversational loop where your agent can execute Gosquared operations

What is CrewAI?

CrewAI is a powerful framework for building multi-agent AI systems. It provides primitives for defining agents with specific roles, creating tasks, and orchestrating workflows through crews.

Key features include:

  • Agent Roles: Define specialized agents with specific goals and backstories
  • Task Management: Create tasks with clear descriptions and expected outputs
  • Crew Orchestration: Combine agents and tasks into collaborative workflows
  • MCP Integration: Connect to external tools through Model Context Protocol

What is the Gosquared MCP server, and what's possible with it?

The Gosquared MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Gosquared account. It provides structured and secure access to your real-time web analytics and customer engagement data, so your agent can perform actions like managing team members, analyzing chat conversations, retrieving site data, and handling customer profiles on your behalf.

  • Team member management: Seamlessly add or remove shared users from your GoSquared projects, making it easy to control who has access to your analytics and engagement tools.
  • Insightful chat analytics: Retrieve chat conversations, messages, and conversation feeds, enabling your agent to analyze customer interactions and surface important chat history.
  • Project and site listing: Quickly list all sites and projects accessible to your account, so your assistant can pull structured data about your web properties.
  • API key validation and security checks: Verify API key validity and scopes to ensure secure, authorized access before performing sensitive operations.
  • Customer profile management: Delete person records, including all associated data, when you need to manage your user database or enforce data privacy requests.

Supported Tools & Triggers

Tools
Add Shared UserTool to add a new shared user to a project.
Remove shared userRemoves a shared user from a GoSquared project by their email address, revoking their access to the site.
Account Shared UsersRetrieves all team members who have access to the current GoSquared project.
List Account SitesList all projects/sites accessible to the authenticated account.
Check API Token Validity and ScopesTool to check whether an API key is valid and retrieve its enabled scopes.
Block VisitorTool to block a specific visitor from being tracked.
Retrieve Chat ConversationRetrieve detailed information about a chat conversation by its ID.
Retrieve Chat MessagesRetrieve messages from a GoSquared chat conversation by chat ID.
Retrieve Chat ConversationsTool to retrieve chat data for reporting purposes.
Retrieve Chat FeedRetrieve the complete feed of messages and events from a chat conversation.
Create Account WebhookTool to create a webhook to receive notifications about events in a GoSquared project.
Create Webhook TriggerTool to add a trigger to an existing GoSquared webhook.
Delete Account WebhookTool to delete a webhook from a GoSquared account.
Delete personTool to delete a person profile and all associated data.
Timeout Visitor SessionsTool to end all tracking sessions for a specified visitor in GoSquared.
Get Account Blocked ItemsTool to retrieve a list of blocked IP addresses, bots, and visitors for a project.
Get Account Blocked BotsTool to retrieve the bot blocking status for a GoSquared project.
Get Blocked IP AddressesTool to retrieve the list of blocked IP addresses for the account.
Get Account Blocked VisitorsTool to retrieve visitor IDs that have been blocked for a project.
Get Account Site DetailsTool to retrieve detailed information about a specific site/project by its site_token.
Get Account Sites UsageTool to retrieve all sites and their pageview counts for the authenticated account.
Get Account Tagged VisitorsTool to retrieve the list of tagged visitors from the account.
Get Account Trigger TypeTool to retrieve details of a specific trigger type from GoSquared.
Get Account Trigger TypesTool to retrieve available types of triggers in GoSquared.
Get Account WebhookTool to retrieve a specific webhook by ID from a GoSquared account.
Get Account WebhooksRetrieves a list of webhooks configured for the GoSquared project.
Get Account Webhook TriggersRetrieves all triggers for a webhook.
Get Specific Chat MessageRetrieve a specific chat message by its message ID from a chat conversation.
Get Real-Time Visitor BrowsersTool to retrieve browsers used by currently online visitors, sorted by visitor count.
Get Real-Time CampaignsTool to retrieve currently running campaigns with real-time visitor counts.
Get Real-Time Visitor CountriesTool to retrieve countries where currently online visitors are located, sorted by visitor count.
Get Real-Time EngagementTool to retrieve engagement information of currently online users.
Get Real-Time Visitor Geo LocationsTool to retrieve real-time geographic coordinates for currently online visitors.
Get Real-Time Visitor LanguagesTool to retrieve languages for currently online visitors sorted by visitor count.
Get Now NotificationsTool to retrieve notifications stored in GoSquared.
Get Real-Time OrganisationsTool to retrieve internet organisations currently being used by online visitors, sorted by visitor count.
Get Now Sources By SectionTool to retrieve a specific group of real-time traffic sources such as 'site', 'organic', or 'social'.
Get Current TimeTool to retrieve the current time according to GoSquared infrastructure.
Get Specific VisitorRetrieves real-time session information for a specific online visitor.
Get People Event TypesRetrieve all event types tracked in GoSquared People CRM, ordered by frequency.
Get People Property TypesRetrieve property types (schema definitions) from GoSquared People CRM.
Get Person ProfileRetrieve a specific person's profile from GoSquared People CRM by their unique ID.
GoSquared - Get Person FeedRetrieve a person's complete event feed from GoSquared People CRM.
Get Browser MetricsTool to retrieve summarised browser metrics over a specified time period.
Get Campaign Content MetricsRetrieve UTM content metrics (utm_content) aggregated over a specified date range.
Get Campaign Name MetricsRetrieve UTM campaign name metrics (utm_campaign) aggregated over a specified date range.
Get Campaign Source MetricsRetrieve UTM source metrics (utm_source) aggregated over a specified date range.
Get Campaign Term MetricsRetrieve UTM term metrics (utm_term) aggregated over a specified date range.
Get Category MetricsTool to retrieve summarised category metrics over a specified time period.
Get Country MetricsRetrieve country-level visit metrics aggregated over a specified date range.
Get Language MetricsRetrieve summarised language metrics over a given time period.
Get Organisation MetricsTool to retrieve summarised organisation metrics over a given time period.
Get Operating System MetricsTool to retrieve summarised operating system metrics over a specified time period.
Get Product MetricsTool to retrieve summarised product metrics over a specified time period.
Get Screen Dimensions MetricsTool to retrieve summarised screen dimensions metrics over a specified time period.
Get Traffic Sources MetricsTool to retrieve a historical list of traffic sources that referred visitors to the site over a specified period.
Get Trends Sources By TypeTool to retrieve a historical list of sources for the given section type.
Get Transaction MetricsTool to retrieve summarised transaction metrics over a specified time period.
List PeopleSearch and filter tracked people in GoSquared People CRM.
Get current concurrent visitorsTool to retrieve the number of concurrent visitors currently on your site.
Get Real-Time Popular PagesRetrieve the most popular pages currently being viewed on your site in real-time.
Get Real-Time Visitor PlatformsTool to retrieve platforms used by online visitors sorted by visitor count.
Get Real-Time OverviewTool to retrieve a summary of real-time data for the site.
Now SourcesTool to retrieve the most influential traffic sources currently driving visitors to your site.
Get Visitor Time SeriesRetrieves time series data showing the number of concurrent visitors to your site over time.
Get Real-Time Online VisitorsTool to retrieve a list of current online visitors.
GoSquared - List All DevicesRetrieve a paginated list of all devices tracked in GoSquared People CRM.
Export Smart Group FeedExport all pageview activity for users in a Smart Group to a downloadable CSV file.
Smart Group PeopleRetrieve people (user profiles) from a specific Smart Group in GoSquared People CRM.
List People Smart GroupsRetrieve all Smart Groups for a GoSquared People CRM project.
Add Account SiteCreates a new site/project in the GoSquared account for analytics tracking.
Archive Chat ConversationArchives a chat conversation in GoSquared Inbox.
Send Chat MessageSend a message to a visitor in a GoSquared chat conversation.
Leave Chat NoteAdds an internal note to a GoSquared chat conversation.
Unarchive Chat ConversationUnarchives a chat conversation in GoSquared Inbox.
Create People SmartGroupCreate a new Smart Group in GoSquared People CRM to segment users by custom criteria.
Send Tracking PingSends a ping to keep the visitor session active in GoSquared.
Tag VisitorTool to add a tag to an identified visitor in GoSquared.
Track GoSquared EventTrack custom events in GoSquared analytics.
Identify UserIdentify a user in GoSquared and set their profile properties.
Track PageviewTracks a pageview event in GoSquared Analytics.
Track GoSquared TransactionTrack e-commerce transactions in GoSquared analytics.
Track User PropertiesTrack user properties for a visitor in GoSquared.
Retrieve Aggregate MetricsRetrieve aggregate web analytics metrics for a specified time period.
Get Campaign Medium MetricsRetrieve UTM medium metrics (utm_medium) aggregated over a specified date range.
Retrieve Event CountsRetrieve counts of tracked event triggers over a specified time period.
Get Page MetricsRetrieve page-level visit metrics over a specified time period.
Get Base Path MetricsRetrieves base path metrics (first URL path segments) over a time period.
Update Account Blocked BotsTool to update the automatic bot blocking feature for a project.
Update Account Blocked IPsTool to update the list of IP addresses to be blocked for a GoSquared project.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Prerequisites

Before starting, make sure you have:
  • Python 3.9 or higher
  • A Composio account and API key
  • A Gosquared connection authorized in Composio
  • An OpenAI API key for the CrewAI LLM
  • Basic familiarity with Python

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Navigate to your API settings and generate a new API key.
  • Store this key securely as you'll need it for authentication.

Install dependencies

bash
pip install composio crewai crewai-tools[mcp] python-dotenv
What's happening:
  • composio connects your agent to Gosquared via MCP
  • crewai provides Agent, Task, Crew, and LLM primitives
  • crewai-tools[mcp] includes MCP helpers
  • python-dotenv loads environment variables from .env

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key_here

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates with Composio
  • USER_ID scopes the session to your account
  • OPENAI_API_KEY lets CrewAI use your chosen OpenAI model

Import dependencies

python
import os
from composio import Composio
from crewai import Agent, Task, Crew
from crewai_tools import MCPServerAdapter
import dotenv

dotenv.load_dotenv()

COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set")
What's happening:
  • CrewAI classes define agents and tasks, and run the workflow
  • MCPServerHTTP connects the agent to an MCP endpoint
  • Composio will give you a short lived Gosquared MCP URL

Create a Composio Tool Router session for Gosquared

python
composio_client = Composio(api_key=COMPOSIO_API_KEY)
session = composio_client.create(user_id=COMPOSIO_USER_ID, toolkits=["gosquared"])

url = session.mcp.url
What's happening:
  • You create a Gosquared only session through Composio
  • Composio returns an MCP HTTP URL that exposes Gosquared tools

Initialize the MCP Server

python
server_params = {
    "url": url,
    "transport": "streamable-http",
    "headers": {"x-api-key": COMPOSIO_API_KEY},
}

with MCPServerAdapter(server_params) as tools:
    agent = Agent(
        role="Search Assistant",
        goal="Help users search the internet effectively",
        backstory="You are a helpful assistant with access to search tools.",
        tools=tools,
        verbose=False,
        max_iter=10,
    )
What's Happening:
  • Server Configuration: The code sets up connection parameters including the MCP server URL, streamable HTTP transport, and Composio API key authentication.
  • MCP Adapter Bridge: MCPServerAdapter acts as a context manager that converts Composio MCP tools into a CrewAI-compatible format.
  • Agent Setup: Creates a CrewAI Agent with a defined role (Search Assistant), goal (help with internet searches), and access to the MCP tools.
  • Configuration Options: The agent includes settings like verbose=False for clean output and max_iter=10 to prevent infinite loops.
  • Dynamic Tool Usage: Once created, the agent automatically accesses all Composio Search tools and decides when to use them based on user queries.

Create a CLI Chatloop and define the Crew

python
print("Chat started! Type 'exit' or 'quit' to end.\n")

conversation_context = ""

while True:
    user_input = input("You: ").strip()

    if user_input.lower() in ["exit", "quit", "bye"]:
        print("\nGoodbye!")
        break

    if not user_input:
        continue

    conversation_context += f"\nUser: {user_input}\n"
    print("\nAgent is thinking...\n")

    task = Task(
        description=(
            f"Conversation history:\n{conversation_context}\n\n"
            f"Current request: {user_input}"
        ),
        expected_output="A helpful response addressing the user's request",
        agent=agent,
    )

    crew = Crew(agents=[agent], tasks=[task], verbose=False)
    result = crew.kickoff()
    response = str(result)

    conversation_context += f"Agent: {response}\n"
    print(f"Agent: {response}\n")
What's Happening:
  • Interactive CLI Setup: The code creates an infinite loop that continuously prompts for user input and maintains the entire conversation history in a string variable.
  • Input Validation: Empty inputs are ignored to prevent processing blank messages and keep the conversation clean.
  • Context Building: Each user message is appended to the conversation context, which preserves the full dialogue history for better agent responses.
  • Dynamic Task Creation: For every user input, a new Task is created that includes both the full conversation history and the current request as context.
  • Crew Execution: A Crew is instantiated with the agent and task, then kicked off to process the request and generate a response.
  • Response Management: The agent's response is converted to a string, added to the conversation context, and displayed to the user, maintaining conversational continuity.

Complete Code

Here's the complete code to get you started with Gosquared and CrewAI:

python
from crewai import Agent, Task, Crew, LLM
from crewai_tools import MCPServerAdapter
from composio import Composio
from dotenv import load_dotenv
import os

load_dotenv()

GOOGLE_API_KEY = os.getenv("GOOGLE_API_KEY")
COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not GOOGLE_API_KEY:
    raise ValueError("GOOGLE_API_KEY is not set in the environment.")
if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set in the environment.")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set in the environment.")

# Initialize Composio and create a session
composio = Composio(api_key=COMPOSIO_API_KEY)
session = composio.create(
    user_id=COMPOSIO_USER_ID,
    toolkits=["gosquared"],
)
url = session.mcp.url

# Configure LLM
llm = LLM(
    model="gpt-5",
    api_key=os.getenv("OPENAI_API_KEY"),
)

server_params = {
    "url": url,
    "transport": "streamable-http",
    "headers": {"x-api-key": COMPOSIO_API_KEY},
}

with MCPServerAdapter(server_params) as tools:
    agent = Agent(
        role="Search Assistant",
        goal="Help users with internet searches",
        backstory="You are an expert assistant with access to Composio Search tools.",
        tools=tools,
        llm=llm,
        verbose=False,
        max_iter=10,
    )

    print("Chat started! Type 'exit' or 'quit' to end.\n")

    conversation_context = ""

    while True:
        user_input = input("You: ").strip()

        if user_input.lower() in ["exit", "quit", "bye"]:
            print("\nGoodbye!")
            break

        if not user_input:
            continue

        conversation_context += f"\nUser: {user_input}\n"
        print("\nAgent is thinking...\n")

        task = Task(
            description=(
                f"Conversation history:\n{conversation_context}\n\n"
                f"Current request: {user_input}"
            ),
            expected_output="A helpful response addressing the user's request",
            agent=agent,
        )

        crew = Crew(agents=[agent], tasks=[task], verbose=False)
        result = crew.kickoff()
        response = str(result)

        conversation_context += f"Agent: {response}\n"
        print(f"Agent: {response}\n")

Conclusion

You now have a CrewAI agent connected to Gosquared through Composio's Tool Router. The agent can perform Gosquared operations through natural language commands.

Next steps:

  • Add role-specific instructions to customize agent behavior
  • Plug in more toolkits for multi-app workflows
  • Chain tasks for complex multi-step operations

How to build Gosquared MCP Agent with another framework

FAQ

What are the differences in Tool Router MCP and Gosquared MCP?

With a standalone Gosquared MCP server, the agents and LLMs can only access a fixed set of Gosquared tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Gosquared and many other apps based on the task at hand, all through a single MCP endpoint.

Can I use Tool Router MCP with CrewAI?

Yes, you can. CrewAI fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Gosquared tools.

Can I manage the permissions and scopes for Gosquared while using Tool Router?

Yes, absolutely. You can configure which Gosquared scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Gosquared data and credentials are handled as safely as possible.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.