How to integrate Loyverse MCP with OpenAI Agents SDK

BOOK A CALLGET STARTED FOR FREE
Framework Integration Gradient
Loyverse Logo
open-ai-agents-sdk Logo
divider

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 my inventory, fetch details for a specific employee, get merchant account info for my store 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.

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 open-ai-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.

Supported Tools & Triggers

Tools
Create SupplierTool to create a new supplier.
Delete CategoryTool to delete a single category by id.
Delete SupplierTool to delete a specific supplier by id.
Get CategoryTool to get a single category by id.
Get DiscountTool to get a single discount by id.
Get EmployeeTool to get a single employee by id.
Get JWKSTool to fetch json web key set for openid connect.
Get Merchant InfoTool to get merchant information.
Get OpenID Connect Discovery DocumentTool to retrieve the openid connect discovery document.
Get Payment TypeTool to get a single payment type by its id.
Get StoreTool to retrieve details of a specific store by its id.
List CategoriesTool to list categories with optional filtering and pagination.
List CustomersTool to get a list of customers.
List DiscountsTool to list discounts.
List EmployeesTool to get a list of employees.
List ItemsTool to list items with filtering and pagination.
List ModifiersTool to list modifiers.
List Payment TypesTool to list payment types.
List ReceiptsTool to retrieve a list of receipts.
List ShiftsTool to list shifts.
List SuppliersTool to retrieve a list of suppliers.
List TaxesTool to list taxes.
List VariantsTool to list variants.
List WebhooksTool to list webhooks.

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

What is Tool Router?

Composio's Tool Router 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 Tool Router

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

How the Tool Router works

The Tool Router follows a three-phase workflow:

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

Step-by-step Guide

Prerequisites

Before starting, make sure you have:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Loyverse project
  • Some knowledge of Python or Typescript

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

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

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.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession
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.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())
What's happening:
  • load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Loyverse Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["loyverse"]
)

mcp_url = 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.

Configure the agent

# Configure agent with MCP tool
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "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 dict includes the Composio API key for secure authentication with the MCP server.
  • require_approval: 'never' means the agent can execute Loyverse operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
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 Runner.run().
  • The responses are printed to the console, and conversations are saved locally using SQLite.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Loyverse and open-ai-agents-sdk:

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["loyverse"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

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.

How to build Loyverse MCP Agent with another framework

Claude Agent SDK

Claude Agent SDK

Use Loyverse MCP with Claude Agent SDK

Google ADK

Google ADK

Use Loyverse MCP with Google ADK

LangChain

LangChain

Use Loyverse MCP with LangChain

Vercel AI SDK

Vercel AI SDK

Use Loyverse MCP with Vercel AI SDK

Mastra AI

Mastra AI

Use Loyverse MCP with Mastra AI

LlamaIndex

LlamaIndex

Use Loyverse MCP with LlamaIndex

CrewAI

CrewAI

Use Loyverse MCP with CrewAI

FAQ

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

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.

Can I use Tool Router MCP with OpenAI Agents SDK?

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.

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

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.

How safe is my data with Composio Tool Router?

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

Used by agents from

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

Never worry about agent reliability

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

Book a call↗Get started for free