How to integrate Gosquared MCP with Mastra AI

This guide walks you through connecting Gosquared to Mastra AI 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 Mastra AI 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.

Gosquared logoGosquared
Api Key

GoSquared is a real-time web analytics and customer engagement platform. It helps businesses understand and interact with website visitors instantly.

90 Tools

Introduction

This guide walks you through connecting Gosquared to Mastra AI 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 Mastra AI 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:
  • Set up your environment so Mastra, OpenAI, and Composio work together
  • Create a Tool Router session in Composio that exposes Gosquared tools
  • Connect Mastra's MCP client to the Composio generated MCP URL
  • Fetch Gosquared tool definitions and attach them as a toolset
  • Build a Mastra agent that can reason, call tools, and return structured results
  • Run an interactive CLI where you can chat with your Gosquared agent

What is Mastra AI?

Mastra AI is a TypeScript framework for building AI agents with tool support. It provides a clean API for creating agents that can use external services through MCP.

Key features include:

  • MCP Client: Built-in support for Model Context Protocol servers
  • Toolsets: Organize tools into logical groups
  • Step Callbacks: Monitor and debug agent execution
  • OpenAI Integration: Works with OpenAI models via @ai-sdk/openai

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.

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

Step by step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Node.js 18 or higher
  • A Composio account with an active API key
  • An OpenAI API key
  • Basic familiarity with TypeScript
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key.
  • You need credits or a connected billing setup to use the models.
  • Store the key somewhere safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Go to Settings and copy your API key.
  • This key lets your Mastra agent talk to Composio and reach Gosquared through MCP.
3

Install dependencies

bash
npm install @composio/core @mastra/core @mastra/mcp @ai-sdk/openai dotenv

Install the required packages.

What's happening:

  • @composio/core is the Composio SDK for creating MCP sessions
  • @mastra/core provides the Agent class
  • @mastra/mcp is Mastra's MCP client
  • @ai-sdk/openai is the model wrapper for OpenAI
  • dotenv loads environment variables from .env
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_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 your requests to Composio
  • COMPOSIO_USER_ID tells Composio which user this session belongs to
  • OPENAI_API_KEY lets the Mastra agent call OpenAI models
5

Import libraries and validate environment

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey as string,
});
What's happening:
  • dotenv/config auto loads your .env so process.env.* is available
  • openai gives you a Mastra compatible model wrapper
  • Agent is the Mastra agent that will call tools and produce answers
  • MCPClient connects Mastra to your Composio MCP server
  • Composio is used to create a Tool Router session
6

Create a Tool Router session for Gosquared

typescript
async function main() {
  const session = await composio.create(
    composioUserID as string,
    {
      toolkits: ["gosquared"],
    },
  );

  const composioMCPUrl = session.mcp.url;
  console.log("Gosquared MCP URL:", composioMCPUrl);
What's happening:
  • create spins up a short-lived MCP HTTP endpoint for this user
  • The toolkits array contains "gosquared" for Gosquared access
  • session.mcp.url is the MCP URL that Mastra's MCPClient will connect to
7

Configure Mastra MCP client and fetch tools

typescript
const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      nasdaq: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

console.log("Fetching MCP tools from Composio...");
const composioTools = await mcpClient.getTools();
console.log("Number of tools:", Object.keys(composioTools).length);
What's happening:
  • MCPClient takes an id for this client and a list of MCP servers
  • The headers property includes the x-api-key for authentication
  • getTools fetches the tool definitions exposed by the Gosquared toolkit
8

Create the Mastra agent

typescript
const agent = new Agent({
    name: "gosquared-mastra-agent",
    instructions: "You are an AI agent with Gosquared tools via Composio.",
    model: "openai/gpt-5",
  });
What's happening:
  • Agent is the core Mastra agent
  • name is just an identifier for logging and debugging
  • instructions guide the agent to use tools instead of only answering in natural language
  • model uses openai("gpt-5") to configure the underlying LLM
9

Set up interactive chat interface

typescript
let messages: AiMessageType[] = [];

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

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: "> ",
});

rl.prompt();

rl.on("line", async (userInput: string) => {
  const trimmedInput = userInput.trim();

  if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
    console.log("\nGoodbye!");
    rl.close();
    process.exit(0);
  }

  if (!trimmedInput) {
    rl.prompt();
    return;
  }

  messages.push({
    id: crypto.randomUUID(),
    role: "user",
    content: trimmedInput,
  });

  console.log("\nAgent is thinking...\n");

  try {
    const response = await agent.generate(messages, {
      toolsets: {
        gosquared: composioTools,
      },
      maxSteps: 8,
    });

    const { text } = response;

    if (text && text.trim().length > 0) {
      console.log(`Agent: ${text}\n`);
        messages.push({
          id: crypto.randomUUID(),
          role: "assistant",
          content: text,
        });
      }
    } catch (error) {
      console.error("\nError:", error);
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    console.log("\nSession ended.");
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});
What's happening:
  • messages keeps the full conversation history in Mastra's expected format
  • agent.generate runs the agent with conversation history and Gosquared toolsets
  • maxSteps limits how many tool calls the agent can take in a single run
  • onStepFinish is a hook that prints intermediate steps for debugging

Complete Code

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

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({ apiKey: composioAPIKey as string });

async function main() {
  const session = await composio.create(composioUserID as string, {
    toolkits: ["gosquared"],
  });

  const composioMCPUrl = session.mcp.url;

  const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      gosquared: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

  const composioTools = await mcpClient.getTools();

  const agent = new Agent({
    name: "gosquared-mastra-agent",
    instructions: "You are an AI agent with Gosquared tools via Composio.",
    model: "openai/gpt-5",
  });

  let messages: AiMessageType[] = [];

  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: "> ",
  });

  rl.prompt();

  rl.on("line", async (input: string) => {
    const trimmed = input.trim();
    if (["exit", "quit"].includes(trimmed.toLowerCase())) {
      rl.close();
      return;
    }

    messages.push({ id: crypto.randomUUID(), role: "user", content: trimmed });

    const { text } = await agent.generate(messages, {
      toolsets: { gosquared: composioTools },
      maxSteps: 8,
    });

    if (text) {
      console.log(`Agent: ${text}\n`);
      messages.push({ id: crypto.randomUUID(), role: "assistant", content: text });
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main();

Conclusion

You've built a Mastra AI agent that can interact with Gosquared through Composio's Tool Router. You can extend this further by:
  • Adding other toolkits like Gmail, Slack, or GitHub
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows
TOOLS

Supported Tools

Every Gosquared action and event your agent gets out of the box.

Add Shared User

Tool to add a new shared user to a project.

Remove shared user

Removes a shared user from a GoSquared project by their email address, revoking their access to the site.

Account Shared Users

Retrieves all team members who have access to the current GoSquared project.

List Account Sites

List all projects/sites accessible to the authenticated account.

Check API Token Validity and Scopes

Tool to check whether an API key is valid and retrieve its enabled scopes.

Block Visitor

Tool to block a specific visitor from being tracked.

Retrieve Chat Conversation

Retrieve detailed information about a chat conversation by its ID.

Retrieve Chat Messages

Retrieve messages from a GoSquared chat conversation by chat ID.

Retrieve Chat Conversations

Tool to retrieve chat data for reporting purposes.

Retrieve Chat Feed

Retrieve the complete feed of messages and events from a chat conversation.

Create Account Webhook

Tool to create a webhook to receive notifications about events in a GoSquared project.

Create Webhook Trigger

Tool to add a trigger to an existing GoSquared webhook.

Delete Account Webhook

Tool to delete a webhook from a GoSquared account.

Delete person

Tool to delete a person profile and all associated data.

Timeout Visitor Sessions

Tool to end all tracking sessions for a specified visitor in GoSquared.

Get Account Blocked Items

Tool to retrieve a list of blocked IP addresses, bots, and visitors for a project.

Get Account Blocked Bots

Tool to retrieve the bot blocking status for a GoSquared project.

Get Blocked IP Addresses

Tool to retrieve the list of blocked IP addresses for the account.

Get Account Blocked Visitors

Tool to retrieve visitor IDs that have been blocked for a project.

Get Account Site Details

Tool to retrieve detailed information about a specific site/project by its site_token.

Get Account Sites Usage

Tool to retrieve all sites and their pageview counts for the authenticated account.

Get Account Tagged Visitors

Tool to retrieve the list of tagged visitors from the account.

Get Account Trigger Type

Tool to retrieve details of a specific trigger type from GoSquared.

Get Account Trigger Types

Tool to retrieve available types of triggers in GoSquared.

Get Account Webhook

Tool to retrieve a specific webhook by ID from a GoSquared account.

Get Account Webhooks

Retrieves a list of webhooks configured for the GoSquared project.

Get Account Webhook Triggers

Retrieves all triggers for a webhook.

Get Specific Chat Message

Retrieve a specific chat message by its message ID from a chat conversation.

Get Real-Time Visitor Browsers

Tool to retrieve browsers used by currently online visitors, sorted by visitor count.

Get Real-Time Campaigns

Tool to retrieve currently running campaigns with real-time visitor counts.

Get Real-Time Visitor Countries

Tool to retrieve countries where currently online visitors are located, sorted by visitor count.

Get Real-Time Engagement

Tool to retrieve engagement information of currently online users.

Get Real-Time Visitor Geo Locations

Tool to retrieve real-time geographic coordinates for currently online visitors.

Get Real-Time Visitor Languages

Tool to retrieve languages for currently online visitors sorted by visitor count.

Get Now Notifications

Tool to retrieve notifications stored in GoSquared.

Get Real-Time Organisations

Tool to retrieve internet organisations currently being used by online visitors, sorted by visitor count.

Get Now Sources By Section

Tool to retrieve a specific group of real-time traffic sources such as 'site', 'organic', or 'social'.

Get Current Time

Tool to retrieve the current time according to GoSquared infrastructure.

Get Specific Visitor

Retrieves real-time session information for a specific online visitor.

Get People Event Types

Retrieve all event types tracked in GoSquared People CRM, ordered by frequency.

Get People Property Types

Retrieve property types (schema definitions) from GoSquared People CRM.

Get Person Profile

Retrieve a specific person's profile from GoSquared People CRM by their unique ID.

GoSquared - Get Person Feed

Retrieve a person's complete event feed from GoSquared People CRM.

Get Browser Metrics

Tool to retrieve summarised browser metrics over a specified time period.

Get Campaign Content Metrics

Retrieve UTM content metrics (utm_content) aggregated over a specified date range.

Get Campaign Name Metrics

Retrieve UTM campaign name metrics (utm_campaign) aggregated over a specified date range.

Get Campaign Source Metrics

Retrieve UTM source metrics (utm_source) aggregated over a specified date range.

Get Campaign Term Metrics

Retrieve UTM term metrics (utm_term) aggregated over a specified date range.

Get Category Metrics

Tool to retrieve summarised category metrics over a specified time period.

Get Country Metrics

Retrieve country-level visit metrics aggregated over a specified date range.

Get Language Metrics

Retrieve summarised language metrics over a given time period.

Get Organisation Metrics

Tool to retrieve summarised organisation metrics over a given time period.

Get Operating System Metrics

Tool to retrieve summarised operating system metrics over a specified time period.

Get Product Metrics

Tool to retrieve summarised product metrics over a specified time period.

Get Screen Dimensions Metrics

Tool to retrieve summarised screen dimensions metrics over a specified time period.

Get Traffic Sources Metrics

Tool to retrieve a historical list of traffic sources that referred visitors to the site over a specified period.

Get Trends Sources By Type

Tool to retrieve a historical list of sources for the given section type.

Get Transaction Metrics

Tool to retrieve summarised transaction metrics over a specified time period.

List People

Search and filter tracked people in GoSquared People CRM.

Get current concurrent visitors

Tool to retrieve the number of concurrent visitors currently on your site.

Get Real-Time Popular Pages

Retrieve the most popular pages currently being viewed on your site in real-time.

Get Real-Time Visitor Platforms

Tool to retrieve platforms used by online visitors sorted by visitor count.

Get Real-Time Overview

Tool to retrieve a summary of real-time data for the site.

Now Sources

Tool to retrieve the most influential traffic sources currently driving visitors to your site.

Get Visitor Time Series

Retrieves time series data showing the number of concurrent visitors to your site over time.

Get Real-Time Online Visitors

Tool to retrieve a list of current online visitors.

GoSquared - List All Devices

Retrieve a paginated list of all devices tracked in GoSquared People CRM.

Export Smart Group Feed

Export all pageview activity for users in a Smart Group to a downloadable CSV file.

Smart Group People

Retrieve people (user profiles) from a specific Smart Group in GoSquared People CRM.

List People Smart Groups

Retrieve all Smart Groups for a GoSquared People CRM project.

Add Account Site

Creates a new site/project in the GoSquared account for analytics tracking.

Archive Chat Conversation

Archives a chat conversation in GoSquared Inbox.

Send Chat Message

Send a message to a visitor in a GoSquared chat conversation.

Leave Chat Note

Adds an internal note to a GoSquared chat conversation.

Unarchive Chat Conversation

Unarchives a chat conversation in GoSquared Inbox.

Create People SmartGroup

Create a new Smart Group in GoSquared People CRM to segment users by custom criteria.

Send Tracking Ping

Sends a ping to keep the visitor session active in GoSquared.

Tag Visitor

Tool to add a tag to an identified visitor in GoSquared.

Track GoSquared Event

Track custom events in GoSquared analytics.

Identify User

Identify a user in GoSquared and set their profile properties.

Track Pageview

Tracks a pageview event in GoSquared Analytics.

Track GoSquared Transaction

Track e-commerce transactions in GoSquared analytics.

Track User Properties

Track user properties for a visitor in GoSquared.

Retrieve Aggregate Metrics

Retrieve aggregate web analytics metrics for a specified time period.

Get Campaign Medium Metrics

Retrieve UTM medium metrics (utm_medium) aggregated over a specified date range.

Retrieve Event Counts

Retrieve counts of tracked event triggers over a specified time period.

Get Page Metrics

Retrieve page-level visit metrics over a specified time period.

Get Base Path Metrics

Retrieves base path metrics (first URL path segments) over a time period.

Update Account Blocked Bots

Tool to update the automatic bot blocking feature for a project.

Update Account Blocked IPs

Tool to update the list of IP addresses to be blocked for a GoSquared project.

FAQ

Frequently asked questions

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.

Yes, you can. Mastra AI 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.

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.

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.

Start with Gosquared.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Gosquared tool your agent needs.Free to start.

Start building