How to integrate Loyverse MCP with OpenAI Agents SDK

This guide walks you through connecting Loyverse to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Loyverse agent that can add a new supplier for fresh produce, remove unused category from your inventory, fetch details for a specific employee through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Loyverse account through Composio's Loyverse MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Loyverse logoLoyverse
Api Key

Loyverse is a point-of-sale (POS) platform for small businesses, offering tools for sales, inventory, and customer loyalty. It helps streamline retail operations and boost customer engagement.

58 Tools

Introduction

This guide walks you through connecting Loyverse to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Loyverse agent that can add a new supplier for fresh produce, remove unused category from your inventory, fetch details for a specific employee through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Loyverse account through Composio's Loyverse MCP server.

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

Also integrate Loyverse with

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Loyverse
  • Configure an AI agent that can use Loyverse as a tool
  • Run a live chat session where you can ask the agent to perform Loyverse operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

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

The Loyverse MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Loyverse account. It provides structured and secure access to your retail management data, so your agent can perform actions like managing inventory categories, handling suppliers, retrieving employee info, and accessing payment types on your behalf.

  • Supplier management and automation: Easily create or delete suppliers, streamlining your purchase and vendor workflows without logging into Loyverse manually.
  • Category organization and clean-up: Fetch details of specific inventory categories or remove deprecated ones to keep your product catalog organized and up-to-date.
  • Employee and merchant insights: Retrieve detailed information about employees and your merchant account to support HR, payroll, or business analysis tasks.
  • Discount and payment method lookup: Instantly access details for discounts and payment types, making it simple to verify offers or payment options during sales operations.
  • Authentication and security integration: Fetch OpenID Connect details and JWKS keys, allowing your agent to manage secure authentication and integration workflows.

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:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Loyverse project
  • Some knowledge of Python or Typescript
2

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
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

5

Import dependencies

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Loyverse.
6

Set up the Composio instance

dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
What's happening:
  • dotenv.config() loads your .env file so COMPOSIO_API_KEY and USER_ID are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.
7

Create a Tool Router session

// Create Tool Router session for Loyverse
const session = await composio.create(userId as string, {
  toolkits: ['loyverse'],
});
const mcpUrl = session.mcp.url;

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only loyverse.
  • The router checks the user's Loyverse connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Loyverse.
  • This approach keeps things lightweight and lets the agent request Loyverse tools only when needed during the conversation.
8

Configure the agent

// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access Loyverse. Help users perform Loyverse operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: 'never',
    }),
  ],
});
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Loyverse and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a hostedMcpTool that connects to the MCP server URL we created earlier.
  • The headers object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Loyverse operations without asking for permission each time, making interactions smoother.
9

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

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

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
What's happening:
  • The program prints a session URL that you visit to authorize Loyverse.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using run().
  • The responses are printed to the console.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Loyverse and OpenAI Agents SDK:

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['loyverse'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access Loyverse. Help users perform Loyverse operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

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

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});

Conclusion

This was a starter code for integrating Loyverse MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Loyverse.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.
TOOLS

Supported Tools

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

Create or Update Category

Tool to create a new category or update an existing one.

Create or Update Customer

Tool to create a new customer or update an existing one in Loyverse.

Create or Update Discount

Tool to create or update a single discount.

Create or Update Item

Tool to create a new item or update an existing one in Loyverse inventory.

Create or Update Modifier

Tool to create or update a single modifier with options.

Create or Update POS Device

Tool to create a new POS device or update an existing one.

Create or Update Supplier

Tool to create a new supplier or update an existing one in Loyverse.

Create or Update Tax

Tool to create or update a single tax.

Create or Update Variant

Tool to create or update a single item variant in Loyverse.

Create or Update Webhook

Tool to create a new webhook subscription or update an existing one in Loyverse.

Create Receipt

Tool to create a sales receipt with line items and payments.

Create Refund

Tool to create a refund receipt for a sales receipt.

Delete Category

Tool to delete a single category by ID.

Delete Customer

Tool to delete a single customer by their ID.

Delete Discount

Tool to delete a single discount by ID.

Delete Item

Tool to delete a single item by ID.

Delete Item Image

Tool to delete a single image from an item.

Delete Modifier

Tool to delete a single modifier by its ID.

Delete POS Device

Tool to delete a single POS device by its ID.

Delete Supplier

Tool to delete a specific supplier by ID.

Delete Tax

Tool to delete a single tax by its ID.

Delete Variant

Tool to delete a single item variant by its ID.

Delete Webhook

Tool to delete a single webhook by its ID.

Get Category

Tool to get a single category by ID.

Get Customer

Tool to get a single customer by their ID.

Get Discount

Tool to get a single discount by ID.

Get Employee

Tool to get a single employee by ID.

Get Item

Tool to get a single item by ID including all its variants.

Get JWKS

Tool to fetch JSON Web Key Set for OpenID Connect.

Get Merchant Info

Tool to get merchant information.

Get Modifier

Tool to get a single modifier by ID.

Get OpenID Connect Discovery Document

Tool to retrieve the OpenID Connect discovery document.

Get Payment Type

Tool to get a single payment type by its ID.

Get POS Device

Tool to retrieve details of a specific POS device by its ID.

Get Receipt

Tool to retrieve a single receipt by its receipt number.

Get Store

Tool to retrieve details of a specific store by its ID.

Get Supplier

Tool to get a single supplier by their ID.

Get Tax

Tool to get a single tax by ID.

Get Variant

Tool to get a single item variant by its ID.

Get Webhook

Tool to get a single webhook by its ID.

List Categories

Tool to list categories with optional filtering and pagination.

List Customers

Tool to get a list of customers.

List Discounts

Tool to list discounts.

List Employees (Advanced)

Tool to get a list of employees with advanced filtering options.

List Inventory

Retrieves inventory levels for item variants across stores in the Loyverse system.

List Items

Retrieves a paginated list of items (products) from the Loyverse inventory.

List Modifiers (Enhanced)

Tool to get a list of modifiers sorted by created_at in descending order.

List Payment Types

Tool to list payment types.

List POS Devices

Tool to get a list of POS devices sorted by creation date in descending order.

List Receipts

Tool to retrieve a list of receipts.

List Shifts

Tool to list shifts.

List Stores

Tool to get a list of stores sorted by creation date (newest first).

List Suppliers

Tool to retrieve a list of suppliers.

List Taxes

Tool to get a list of taxes sorted by creation date (newest first).

List Variants

Tool to get a list of item variants sorted by creation date (newest first).

List Webhooks

Tool to list webhooks.

Update Inventory

Tool to batch update inventory levels for item variants at specific stores.

Upload Item Image

Tool to upload a single image for an item.

FAQ

Frequently asked questions

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

Yes, you can. OpenAI Agents SDK 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 Loyverse tools.

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

Start with Loyverse.It takes 30 seconds.

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

Start building