How to integrate Apaleo MCP with OpenAI Agents SDK

This guide walks you through connecting Apaleo to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Apaleo agent that can archive a property that's no longer active, clone existing property for new location, create a new unit group for suites through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Apaleo account through Composio's Apaleo MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Apaleo logoApaleo
Oauth2

Apaleo is a cloud-based property management platform for hospitality businesses. It centralizes reservations, billing, and daily operations for smoother hotel management.

29 Tools

Introduction

This guide walks you through connecting Apaleo to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Apaleo agent that can archive a property that's no longer active, clone existing property for new location, create a new unit group for suites through natural language commands.

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

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

Also integrate Apaleo 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 Apaleo
  • Configure an AI agent that can use Apaleo as a tool
  • Run a live chat session where you can ask the agent to perform Apaleo 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 Apaleo MCP server, and what's possible with it?

The Apaleo MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Apaleo account. It provides structured and secure access to your property management operations, so your agent can perform actions like managing properties, handling units, checking availability, and automating setup tasks on your behalf.

  • Property management and archiving: Enable your agent to create, clone, or archive properties, letting you quickly scale or reorganize your portfolio as your business evolves.
  • Unit and unit group operations: Let your agent create new units or unit groups, check if specific units exist, and manage all aspects of your inventory with ease.
  • Attribute and setup automation: Ask your agent to create or verify unit attributes, ensuring your property data is always up-to-date and consistent.
  • Bulk unit creation: Allow your agent to generate multiple units in one go, following custom naming rules, to save you time during onboarding or expansion.
  • Property cloning and rapid deployment: Have your agent clone existing properties with all inventory and rate plans, making it simple to launch new locations based on proven setups.

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 Apaleo 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 Apaleo.
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 Apaleo
const session = await composio.create(userId as string, {
  toolkits: ['apaleo'],
});
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 apaleo.
  • The router checks the user's Apaleo connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Apaleo.
  • This approach keeps things lightweight and lets the agent request Apaleo 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 Apaleo. Help users perform Apaleo 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 Apaleo 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 Apaleo 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 Apaleo.
  • 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 Apaleo 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: ['apaleo'],
  });
  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 Apaleo. Help users perform Apaleo 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 Apaleo MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Apaleo.

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 Apaleo action and event your agent gets out of the box.

Archive a property

Use this endpoint to archive an existing live property This operation set the IsArchived flag to trueYou must have at least one of these scopes: 'properties.

Check if a property exists

Check if a property exists by id.

Check if a unit attribute exists

Check if a unit attribute existsYou must have at least one of these scopes: 'unitattributes.

Check if a unit exists

Check if a unit exists by id.

Check if a unit group exists

Check if a unit group exists by id.

Clones a property

Use this call to clone a specific property.

Create a unit

Use this call to create a new unit.

Create a unit attribute

Use this call to create a new unit attribute.

Create a unit group

Use this call to create a new unit group.

Create multiple units

Use this call to create multiple units, following a naming rule.

Creates a property

Use this call to create a new property.

Delete a unit

Use this call to delete a unit.

Delete a unit group

Use this call to delete a unit group.

Deletes unit attribute

Deletes unit attributeYou must have at least one of these scopes: 'unitattributes.

Get a properties list

Get the list of properties.

Get a property

Get a property by id.

Get a unit

Get a unit by id.

Get a unit group

Get a unit group by id.

Get a units list

Get the list of units.

Get unit attribute by id

Get unit attribute by idYou must have at least one of these scopes: 'unitattributes.

Get unit attribute list

Get unit attribute listYou must have at least one of these scopes: 'unitattributes.

List Unit Groups

Get the list of unit groups.

Move property to live

Use this endpoint to move an existing test property to live This operation changes the property status to 'Live'You must have at least one of these scopes: 'properties.

Replace a unit group

Use this call to modify a unit group.

Reset Property Data

This endpoint deletes transactional data for a property in 'Test' status.

Returns a list of supported countries

Returns a list of ISO country codes that could be used to create properties.

Returns number of unit groups

Returns number of unit groups matching the filter criteriaYou must have at least one of these scopes: 'unitgroups.

Returns number of units

Returns number of units matching the filter criteriaYou must have at least one of these scopes: 'units.

Return total count of properties

Return total count of propertiesYou need to be authorized (no particular scope required)

FAQ

Frequently asked questions

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

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

Start with Apaleo.It takes 30 seconds.

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

Start building