How to integrate Gosquared MCP with LlamaIndex

This guide walks you through connecting Gosquared to LlamaIndex 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 LlamaIndex 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 LlamaIndex 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 LlamaIndex 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 your OpenAI and Composio API keys
  • Install LlamaIndex and Composio packages
  • Create a Composio Tool Router session for Gosquared
  • Connect LlamaIndex to the Gosquared MCP server
  • Build a Gosquared-powered agent using LlamaIndex
  • Interact with Gosquared through natural language

What is LlamaIndex?

LlamaIndex is a data framework for building LLM applications. It provides tools for connecting LLMs to external data sources and services through agents and tools.

Key features include:

  • ReAct Agent: Reasoning and acting pattern for tool-using agents
  • MCP Tools: Native support for Model Context Protocol
  • Context Management: Maintain conversation context across interactions
  • Async Support: Built for async/await patterns

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 step10 STEPS
1

Prerequisites

Before you begin, make sure you have:
  • Python 3.8/Node 16 or higher installed
  • A Composio account with the API key
  • An OpenAI API key
  • A Gosquared account and project
  • Basic familiarity with async Python/Typescript
2

Getting API Keys for OpenAI, Composio, and Gosquared

OpenAI API key (OPENAI_API_KEY)
  • Go to the OpenAI dashboard
  • Create an API key if you don't have one
  • Assign it to OPENAI_API_KEY in .env
Composio API key and user ID
  • Log into the Composio dashboard
  • Copy your API key from Settings
    • Use this as COMPOSIO_API_KEY
  • Pick a stable user identifier (email or ID)
    • Use this as COMPOSIO_USER_ID
3

Installing dependencies

npm install @composio/llamaindex @llamaindex/openai @llamaindex/tools @llamaindex/workflow dotenv

Create a new Typescript project and install the necessary dependencies:

  • @composio/llamaindex: Composio's LlamaIndex integration
  • @llamaindex/openai: OpenAI LLM integration
  • @llamaindex/tools: MCP client for LlamaIndex
  • @llamaindex/workflow: Workflow framework for LlamaIndex
  • dotenv: Environment variable management
4

Set environment variables

bash
OPENAI_API_KEY=your-openai-api-key
COMPOSIO_API_KEY=your-composio-api-key
COMPOSIO_USER_ID=your-user-id

Create a .env file in your project root:

These credentials will be used to:

  • Authenticate with OpenAI's GPT-5 model
  • Connect to Composio's Tool Router
  • Identify your Composio user session for Gosquared access
5

Import modules

import "dotenv/config";
import readline from "node:readline/promises";
import { stdin as input, stdout as output } from "node:process";

import { Composio } from "@composio/core";

import { mcp } from "@llamaindex/tools";
import { agent as createAgent } from "@llamaindex/workflow";
import { openai } from "@llamaindex/openai";

dotenv.config();

Create a new file called gosquared_llamaindex_agent.ts and import the required modules:

Key imports:

  • dotenv.config loads .env at runtime
  • readline gives us a simple CLI chat loop
  • Composio is the main Composio SDK client
  • mcp connects to an MCP endpoint
  • createAgent builds a LlamaIndex agent
  • openai configures the LLM backend
6

Load environment variables and initialize Composio

const OPENAI_API_KEY = process.env.OPENAI_API_KEY;
const COMPOSIO_API_KEY = process.env.COMPOSIO_API_KEY;
const COMPOSIO_USER_ID = process.env.COMPOSIO_USER_ID;

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

What's happening:

This ensures missing credentials cause early, clear errors before the agent attempts to initialise.

7

Create a Tool Router session and build the agent function

async function buildAgent() {

  console.log(`Initializing Composio client...${COMPOSIO_USER_ID!}...`);
  console.log(`COMPOSIO_USER_ID: ${COMPOSIO_USER_ID!}...`);

  const composio = new Composio({
    apiKey: COMPOSIO_API_KEY,
    provider: new LlamaindexProvider(),
  });

  const session = await composio.create(
    COMPOSIO_USER_ID!,
    {
      toolkits: ["gosquared"],
    },
  );

  const mcpUrl = session.mcp.url;
  console.log(`Composio Tool Router MCP URL: ${mcpUrl}`);

  const server = mcp({
    url: mcpUrl,
    clientName: "composio_tool_router_with_llamaindex",
    requestInit: {
      headers: {
        "x-api-key": COMPOSIO_API_KEY!,
      },
    },
    // verbose: true,
  });

  const tools = await server.tools();

  const llm = openai({ apiKey: OPENAI_API_KEY, model: "gpt-5" });

  const agent = createAgent({
    name: "composio_tool_router_with_llamaindex",
        description : "An agent that uses Composio Tool Router MCP tools to perform actions.",
    systemPrompt:
      "You are a helpful assistant connected to Composio Tool Router."+
"Use the available tools to answer user queries and perform Gosquared actions." ,
    llm,
    tools,
  });

  return agent;
}

What's happening here:

  • We create a Composio client using your API key and configure it with the LlamaIndex provider
  • We then create a tool router MCP session for your user, specifying the toolkits we want to use (in this case, gosquared)
  • The session returns an MCP HTTP endpoint URL that acts as a gateway to all your configured tools
  • LlamaIndex will connect to this endpoint to dynamically discover and use the available Gosquared tools.
  • The MCP tools are mapped to LlamaIndex-compatible tools and plug them into the Agent.
8

Create an interactive chat loop

async function chatLoop(agent: ReturnType<typeof createAgent>) {
  const rl = readline.createInterface({ input, output });

  console.log("Type 'quit' or 'exit' to stop.");

  while (true) {
    let userInput: string;

    try {
      userInput = (await rl.question("\nYou: ")).trim();
    } catch {
      console.log("\nAgent: Bye!");
      break;
    }

    if (!userInput) {
      continue;
    }

    const lower = userInput.toLowerCase();
    if (lower === "quit" || lower === "exit") {
      console.log("Agent: Bye!");
      break;
    }

    try {
      process.stdout.write("Agent: ");

      const stream = agent.runStream(userInput);
      let finalResult: any = null;

      for await (const event of stream) {
        // The event.data contains the streamed content
        const data: any = event.data;

        // Check for streaming delta content
        if (data?.delta) {
          process.stdout.write(data.delta);
        }

        // Store final result for fallback
        if (data?.result || data?.message) {
          finalResult = data;
        }
      }

      // If no streaming happened, show the final result
      if (finalResult) {
        const answer =
          finalResult.result ??
          finalResult.message?.content ??
          finalResult.message ??
          "";
        if (answer && typeof answer === "string" && !answer.includes("[object")) {
          process.stdout.write(answer);
        }
      }

      console.log(); // New line after streaming completes
    } catch (err: any) {
      console.error("\nAgent error:", err?.message ?? err);
    }
  }

  rl.close();
}

What's happening:

  • We're creating a direct terminal interface to chat with Gosquared
  • The LLM's responses are streamed to the CLI for faster interaction.
  • The agent uses context to maintain conversation history
  • The agent processes the request, selects appropriate Gosquared tools, and returns a result
  • We extract the answer from the result data structure and display it to the user
  • You can type 'quit' or 'exit' to stop the chat loop gracefully
  • Agent responses and any errors are streamed in a clear, readable format
9

Define the main entry point

async function main() {
  try {
    const agent = await buildAgent();
    await chatLoop(agent);
  } catch (err) {
    console.error("Failed to start agent:", err);
    process.exit(1);
  }
}

main();

What's happening here:

  • We're orchestrating the entire application flow
  • The agent gets built with proper error handling
  • Then we kick off the interactive chat loop so you can start talking to Gosquared
10

Run the agent

npx ts-node llamaindex-agent.ts

When prompted, authenticate and authorise your agent with Gosquared, then start asking questions.

Complete Code

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

import "dotenv/config";
import readline from "node:readline/promises";
import { stdin as input, stdout as output } from "node:process";

import { Composio } from "@composio/core";
import { LlamaindexProvider } from "@composio/llamaindex";

import { mcp } from "@llamaindex/tools";
import { agent as createAgent } from "@llamaindex/workflow";
import { openai } from "@llamaindex/openai";

dotenv.config();

const OPENAI_API_KEY = process.env.OPENAI_API_KEY;
const COMPOSIO_API_KEY = process.env.COMPOSIO_API_KEY;
const COMPOSIO_USER_ID = process.env.COMPOSIO_USER_ID;

if (!OPENAI_API_KEY) {
    throw new Error("OPENAI_API_KEY is not set in the environment");
  }
if (!COMPOSIO_API_KEY) {
    throw new Error("COMPOSIO_API_KEY is not set in the environment");
  }
if (!COMPOSIO_USER_ID) {
    throw new Error("COMPOSIO_USER_ID is not set in the environment");
  }

async function buildAgent() {

  console.log(`Initializing Composio client...${COMPOSIO_USER_ID!}...`);
  console.log(`COMPOSIO_USER_ID: ${COMPOSIO_USER_ID!}...`);

  const composio = new Composio({
    apiKey: COMPOSIO_API_KEY,
    provider: new LlamaindexProvider(),
  });

  const session = await composio.create(
    COMPOSIO_USER_ID!,
    {
      toolkits: ["gosquared"],
    },
  );

  const mcpUrl = session.mcp.url;
  console.log(`Composio Tool Router MCP URL: ${mcpUrl}`);

  const server = mcp({
    url: mcpUrl,
    clientName: "composio_tool_router_with_llamaindex",
    requestInit: {
      headers: {
        "x-api-key": COMPOSIO_API_KEY!,
      },
    },
    // verbose: true,
  });

  const tools = await server.tools();

  const llm = openai({ apiKey: OPENAI_API_KEY, model: "gpt-5" });

  const agent = createAgent({
    name: "composio_tool_router_with_llamaindex",
    description:
      "An agent that uses Composio Tool Router MCP tools to perform actions.",
    systemPrompt:
      "You are a helpful assistant connected to Composio Tool Router."+
"Use the available tools to answer user queries and perform Gosquared actions." ,
    llm,
    tools,
  });

  return agent;
}

async function chatLoop(agent: ReturnType<typeof createAgent>) {
  const rl = readline.createInterface({ input, output });

  console.log("Type 'quit' or 'exit' to stop.");

  while (true) {
    let userInput: string;

    try {
      userInput = (await rl.question("\nYou: ")).trim();
    } catch {
      console.log("\nAgent: Bye!");
      break;
    }

    if (!userInput) {
      continue;
    }

    const lower = userInput.toLowerCase();
    if (lower === "quit" || lower === "exit") {
      console.log("Agent: Bye!");
      break;
    }

    try {
      process.stdout.write("Agent: ");

      const stream = agent.runStream(userInput);
      let finalResult: any = null;

      for await (const event of stream) {
        // The event.data contains the streamed content
        const data: any = event.data;

        // Check for streaming delta content
        if (data?.delta) {
          process.stdout.write(data.delta);
        }

        // Store final result for fallback
        if (data?.result || data?.message) {
          finalResult = data;
        }
      }

      // If no streaming happened, show the final result
      if (finalResult) {
        const answer =
          finalResult.result ??
          finalResult.message?.content ??
          finalResult.message ??
          "";
        if (answer && typeof answer === "string" && !answer.includes("[object")) {
          process.stdout.write(answer);
        }
      }

      console.log(); // New line after streaming completes
    } catch (err: any) {
      console.error("\nAgent error:", err?.message ?? err);
    }
  }

  rl.close();
}

async function main() {
  try {
    const agent = await buildAgent();
    await chatLoop(agent);
  } catch (err: any) {
    console.error("Failed to start agent:", err?.message ?? err);
    process.exit(1);
  }
}

main();

Conclusion

You've successfully connected Gosquared to LlamaIndex through Composio's Tool Router MCP layer. Key takeaways:
  • Tool Router dynamically exposes Gosquared tools through an MCP endpoint
  • LlamaIndex's ReActAgent handles reasoning and orchestration; Composio handles integrations
  • The agent becomes more capable without increasing prompt size
  • Async Python provides clean, efficient execution of agent workflows
You can easily extend this to other toolkits like Gmail, Notion, Stripe, GitHub, and more by adding them to the toolkits parameter.
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. LlamaIndex 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
Gosquared MCP Integration with LlamaIndex | Composio