How to integrate Square MCP with LlamaIndex

This guide walks you through connecting Square to LlamaIndex using the Composio tool router. By the end, you'll have a working Square agent that can create and send an invoice to a customer, list all recent payments from last week, update item prices in your product catalog through natural language commands. This guide will help you understand how to give your LlamaIndex agent real control over a Square account through Composio's Square MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Square logoSquare
Oauth2

Square is a platform for payment processing, POS, invoicing, and e-commerce. It empowers businesses to accept payments, manage sales, and streamline operations from one place.

96 Tools

Introduction

This guide walks you through connecting Square to LlamaIndex using the Composio tool router. By the end, you'll have a working Square agent that can create and send an invoice to a customer, list all recent payments from last week, update item prices in your product catalog through natural language commands.

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

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

Also integrate Square 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 Square
  • Connect LlamaIndex to the Square MCP server
  • Build a Square-powered agent using LlamaIndex
  • Interact with Square 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 Square MCP server, and what's possible with it?

The Square MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Square account. It provides structured and secure access to your Square business tools, so your agent can perform actions like processing payments, managing invoices, tracking orders, handling customers, and managing inventory on your behalf.

  • Seamless payment processing: Let your agent accept card payments, issue refunds, and manage transactions across your business locations.
  • Automated invoice creation and management: Ask your agent to generate, send, and monitor invoices for your customers, streamlining your billing process.
  • Order and fulfillment tracking: Enable your agent to view, update, and manage orders, helping you keep tabs on fulfillment and delivery status with ease.
  • Customer profile management: Have your agent create, update, or search customer profiles, making it easier to personalize service and maintain up-to-date records.
  • Inventory and item catalog control: Allow your agent to track stock levels, update item details, and organize your catalog for smooth retail operations.

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 Square account and project
  • Basic familiarity with async Python/Typescript
2

Getting API Keys for OpenAI, Composio, and Square

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 Square 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 square_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: ["square"],
    },
  );

  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 Square 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, square)
  • 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 Square 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 Square
  • 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 Square 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 Square
10

Run the agent

npx ts-node llamaindex-agent.ts

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

Complete Code

Here's the complete code to get you started with Square 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: ["square"],
    },
  );

  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 Square 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 Square to LlamaIndex through Composio's Tool Router MCP layer. Key takeaways:
  • Tool Router dynamically exposes Square 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 Square action and event your agent gets out of the box.

Accept Dispute

Accept a dispute and acknowledge liability, returning funds to the cardholder.

Add Group to Customer

Tool to add a customer to a customer group.

Calculate Order

Tool to preview order pricing without creating an order.

Cancel Invoice

Cancels a Square invoice, preventing further payments from being collected.

Cancel Payment

Cancels (voids) a payment that is in APPROVED status.

Create Bulk Customers

Tool to create multiple customer profiles in a single request.

Create Card

Tool to create a card on file.

Create Customer

Tool to create a new customer profile in Square.

Create Customer Custom Attribute Definition

Tool to create a customer-related custom attribute definition.

Create Customer Group

Tool to create a new customer group for a business.

Create Dispute Evidence File

Tool to upload a file as dispute evidence.

Create Dispute Evidence Text

Upload text evidence for a dispute challenge.

Create Invoice Attachment

Upload and attach a file to a Square invoice.

Create Location

Tool to create a new business location in a Square account.

Create Location Custom Attribute Definition

Tool to create a location-related custom attribute definition.

Delete Customer

Tool to delete a Square customer profile.

Delete Customer Custom Attribute

Tool to delete a custom attribute from a customer profile.

Delete Customer Custom Attribute Definition

Tool to delete a customer-related custom attribute definition.

Delete Customer Group

Tool to delete a customer group by its ID.

Bulk Delete Customers

Tool to bulk delete customer profiles from Square.

Delete Dispute Evidence

Removes a specific piece of evidence from a dispute.

Delete Invoice

Tool to delete a Square invoice (only DRAFT invoices can be deleted).

Delete Invoice Attachment

Tool to delete an attachment from a Square invoice.

Delete Location Custom Attribute

Tool to delete a custom attribute from a location.

Delete Location Custom Attribute Definition

Tool to delete a location-related custom attribute definition.

Delete Locations Custom Attributes (Batch)

Tool to delete custom attributes from multiple locations in a single batch request.

Delete Merchant Custom Attribute

Tool to delete a custom attribute from a merchant profile.

Delete Merchant Custom Attribute Definition

Tool to delete a merchant-related custom attribute definition.

Delete Merchants Custom Attributes (Batch)

Tool to delete custom attributes from multiple merchants in a single batch request.

Delete Webhook Subscription

Permanently deletes a webhook subscription by its ID.

Get Business Booking Profile

Tool to retrieve the business booking profile for a Square merchant via GraphQL.

Get Current Merchant

Tool to retrieve merchant information associated with the access token using Square's GraphQL API.

Get Customer Custom Attribute

Retrieves a custom attribute from a customer profile in Square.

Get Customer Custom Attribute Definition

Tool to retrieve a customer-related custom attribute definition from Square.

Get Customers via GraphQL

Tool to retrieve customer profiles from Square Customer Directory using GraphQL API.

Get Dispute Evidence

Retrieves detailed information about a specific piece of evidence that was uploaded for a dispute.

Get Invoice

Retrieves detailed information about a specific Square invoice by its ID.

Get Merchant

Tool to retrieve detailed information about a specific Square merchant by ID.

Get Online Checkout Location Settings

Tool to retrieve location-level settings for Square online checkout.

List Channels

Tool to list requested channels from Square.

List Customer Custom Attribute Definitions

Tool to list customer-related custom attribute definitions from Square.

List Customer Custom Attribute Definitions (GraphQL)

Tool to retrieve customer custom attribute definitions via Square's GraphQL API.

List Customer Custom Attributes

Tool to list custom attributes for a customer profile.

List Customer Groups

Tool to retrieve the list of customer groups of a business.

List Customers

Tool to retrieve customer profiles associated with a Square account.

List Customer Segments

Tool to retrieve the list of customer segments of a business.

List Dispute Evidence

Tool to list evidence items associated with a given dispute.

List Invoices

Tool to list invoices for a Square location.

List Location Custom Attribute Definitions

Tool to list location-related custom attribute definitions from Square.

List Locations

Tool to retrieve all business locations from a Square account.

List Locations Custom Attributes

Tool to list custom attributes for a specific location in Square.

List Merchant Custom Attribute Definitions

Tool to list merchant-related custom attribute definitions from Square.

List Merchants

Tool to retrieve merchant account information associated with the access token.

List Merchants Custom Attributes

Tool to list custom attributes for a specific merchant in Square.

List Payments

Tool to list payments by location and time range to enable reconciliation and net sales reporting from Square POS.

List Webhook Event Types

Tool to list available webhook event types.

List Webhook Subscriptions

List all webhook subscriptions owned by your application.

Remove Group From Customer

Removes a customer from a customer group.

Retrieve Bulk Customers

Tool to retrieve multiple customer profiles in a single request.

Retrieve Channel

Retrieve a Square channel by its ID.

Bulk Retrieve Channels

Tool to bulk retrieve multiple Square channels by their IDs in a single request.

Retrieve Customer

Tool to retrieve detailed information about a specific Square customer by ID.

Retrieve Customer Group

Tool to retrieve a specific Square customer group by ID.

Retrieve Customer Segment

Tool to retrieve a specific customer segment by its ID.

Retrieve Dispute

Tool to retrieve a Square dispute by ID.

Retrieve Location

Tool to retrieve detailed information about a specific Square location by ID.

Retrieve Location Custom Attribute

Retrieves a custom attribute associated with a location in Square.

Retrieve Location Custom Attribute Definition

Tool to retrieve a location-related custom attribute definition.

Retrieve Merchant Custom Attribute

Retrieves a custom attribute associated with a merchant in Square.

Retrieve Merchant Custom Attribute Definition

Tool to retrieve a merchant-related custom attribute definition from Square.

Retrieve Merchants

Tool to retrieve merchant information including status, main location details, and capabilities using Square's GraphQL API.

Retrieve Order

Retrieves detailed information about a specific Square order by its ID.

Retrieve Payment Link

Retrieves a Square-hosted payment link by ID.

Retrieve Token Status

Tool to retrieve information about an OAuth access token or personal access token.

Retrieve Webhook Subscription

Retrieve a Square webhook subscription by its ID.

Search Customers

Tool to search customer profiles in Square Customer Directory.

Search Orders

Tool to search orders across one or more Square locations with filters.

Submit Dispute Evidence

Submits evidence for a dispute to the cardholder's bank.

Test Webhook Subscription

Tests a webhook subscription by sending a test event to the configured notification URL.

Update Customer

Tool to update an existing Square customer profile.

Update Customer Custom Attribute Definition

Tool to update a customer-related custom attribute definition in Square.

Update Customer Group

Tool to update a customer group's information by its ID.

Bulk Update Customers

Tool to update multiple customer profiles in a single batch operation.

Update Location

Tool to update an existing business location in a Square account.

Update Location Custom Attribute Definition

Tool to update a location-related custom attribute definition in Square.

Update Merchant Custom Attribute Definition

Tool to update a merchant-related custom attribute definition in Square.

Update Online Checkout Location Settings

Tool to update location-level settings for Square online checkout.

Update Order

Updates an existing Square order by adding, modifying, or removing fields.

Update Webhook Subscription

Tool to update a Square webhook subscription.

Update Webhook Subscription Signature Key

Tool to rotate the signature key for a webhook subscription.

Upsert Customer Custom Attribute

Tool to create or update a custom attribute for a customer profile.

Batch Upsert Customer Custom Attributes

Tool to create or update custom attributes for multiple customers in a single batch request.

Upsert Location Custom Attribute

Tool to create or update a custom attribute for a location.

Batch Upsert Locations Custom Attributes

Tool to create or update custom attributes for multiple locations in a single batch request.

Upsert Merchant Custom Attribute

Tool to create or update a custom attribute for a merchant profile.

Batch Upsert Merchants Custom Attributes

Tool to create or update custom attributes for multiple merchants in a single batch request.

FAQ

Frequently asked questions

With a standalone Square MCP server, the agents and LLMs can only access a fixed set of Square tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Square 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 Square tools.

Yes, absolutely. You can configure which Square 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 Square data and credentials are handled as safely as possible.

Start with Square.It takes 30 seconds.

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

Start building