# How to integrate Apaleo MCP with Pydantic AI

```json
{
  "title": "How to integrate Apaleo MCP with Pydantic AI",
  "toolkit": "Apaleo",
  "toolkit_slug": "apaleo",
  "framework": "Pydantic AI",
  "framework_slug": "pydantic-ai",
  "url": "https://composio.dev/toolkits/apaleo/framework/pydantic-ai",
  "markdown_url": "https://composio.dev/toolkits/apaleo/framework/pydantic-ai.md",
  "updated_at": "2026-05-12T10:01:18.549Z"
}
```

## Introduction

This guide walks you through connecting Apaleo to Pydantic AI 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 Pydantic AI 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

- [OpenAI Agents SDK](https://composio.dev/toolkits/apaleo/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/apaleo/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/apaleo/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/apaleo/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/apaleo/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/apaleo/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/apaleo/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/apaleo/framework/cli)
- [Google ADK](https://composio.dev/toolkits/apaleo/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/apaleo/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/apaleo/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/apaleo/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/apaleo/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/apaleo/framework/crew-ai)

## TL;DR

Here's what you'll learn:
- How to set up your Composio API key and User ID
- How to create a Composio Tool Router session for Apaleo
- How to attach an MCP Server to a Pydantic AI agent
- How to stream responses and maintain chat history
- How to build a simple REPL-style chat interface to test your Apaleo workflows

## What is Pydantic AI?

Pydantic AI is a Python framework for building AI agents with strong typing and validation. It leverages Pydantic's data validation capabilities to create robust, type-safe AI applications.
Key features include:
- Type Safety: Built on Pydantic for automatic data validation
- MCP Support: Native support for Model Context Protocol servers
- Streaming: Built-in support for streaming responses
- Async First: Designed for async/await patterns

## 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.

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `APALEO_ARCHIVE_A_PROPERTY` | 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.manage, setup.manage'. |
| `APALEO_CHECK_IF_A_PROPERTY_EXISTS` | Check if a property exists | Check if a property exists by id.You need to be authorized (no particular scope required) |
| `APALEO_CHECK_IF_A_UNIT_ATTRIBUTE_EXISTS` | Check if a unit attribute exists | Check if a unit attribute existsYou must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'. |
| `APALEO_CHECK_IF_A_UNIT_EXISTS` | Check if a unit exists | Check if a unit exists by id.You must have at least one of these scopes: 'units.read, setup.read, setup.manage'. |
| `APALEO_CHECK_IF_A_UNIT_GROUP_EXISTS` | Check if a unit group exists | Check if a unit group exists by id.You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'. |
| `APALEO_CLONES_A_PROPERTY` | Clones a property | Use this call to clone a specific property. This operation creates a new property with inventory and rate plans from the specified property.You must have at least one of these scopes: 'properties.create, setup.manage'. |
| `APALEO_CREATE_A_UNIT` | Create a unit | Use this call to create a new unit.You must have at least one of these scopes: 'units.create, setup.manage'. |
| `APALEO_CREATE_A_UNIT_ATTRIBUTE` | Create a unit attribute | Use this call to create a new unit attribute.You must have at least one of these scopes: 'unitattributes.create, setup.manage'. |
| `APALEO_CREATE_A_UNIT_GROUP` | Create a unit group | Use this call to create a new unit group.You must have at least one of these scopes: 'unitgroups.create, setup.manage'. |
| `APALEO_CREATE_MULTIPLE_UNITS` | Create multiple units | Use this call to create multiple units, following a naming rule.You must have at least one of these scopes: 'units.create, setup.manage'. |
| `APALEO_CREATES_A_PROPERTY` | Creates a property | Use this call to create a new property.You must have at least one of these scopes: 'properties.create, setup.manage'. |
| `APALEO_DELETE_A_UNIT` | Delete a unit | Use this call to delete a unit.You must have at least one of these scopes: 'units.delete, setup.manage'. |
| `APALEO_DELETE_A_UNIT_GROUP` | Delete a unit group | Use this call to delete a unit group.You must have at least one of these scopes: 'unitgroups.delete, setup.manage'. |
| `APALEO_DELETES_UNIT_ATTRIBUTE` | Deletes unit attribute | Deletes unit attributeYou must have at least one of these scopes: 'unitattributes.delete, setup.manage'. |
| `APALEO_GET_A_PROPERTIES_LIST` | Get a properties list | Get the list of properties.You need to be authorized (no particular scope required) |
| `APALEO_GET_A_PROPERTY` | Get a property | Get a property by id.You need to be authorized (no particular scope required) |
| `APALEO_GET_A_UNIT` | Get a unit | Get a unit by id.You must have at least one of these scopes: 'units.read, setup.read, setup.manage'. |
| `APALEO_GET_A_UNIT_GROUP` | Get a unit group | Get a unit group by id.You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'. |
| `APALEO_GET_A_UNITS_LIST` | Get a units list | Get the list of units.You must have at least one of these scopes: 'units.read, setup.read, setup.manage'. |
| `APALEO_GET_UNIT_ATTRIBUTE_BY_ID` | Get unit attribute by id | Get unit attribute by idYou must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'. |
| `APALEO_GET_UNIT_ATTRIBUTE_LIST` | Get unit attribute list | Get unit attribute listYou must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'. |
| `APALEO_LIST_UNIT_GROUPS` | List Unit Groups | Get the list of unit groups.You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'. |
| `APALEO_MOVE_PROPERTY_TO_LIVE` | 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.manage, setup.manage'. |
| `APALEO_REPLACE_A_UNIT_GROUP` | Replace a unit group | Use this call to modify a unit group.You must have at least one of these scopes: 'unitgroups.manage, setup.manage'. |
| `APALEO_RESET_PROPERTY_DATA` | Reset Property Data | This endpoint deletes transactional data for a property in 'Test' status. Requires 'properties.manage' or 'setup.manage' scopes. |
| `APALEO_RETURNS_A_LIST_OF_SUPPORTED_COUNTRIES` | Returns a list of supported countries | Returns a list of ISO country codes that could be used to create properties.You need to be authorized (no particular scope required) |
| `APALEO_RETURNS_NUMBER_OF_UNIT_GROUPS` | Returns number of unit groups | Returns number of unit groups matching the filter criteriaYou must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'. |
| `APALEO_RETURNS_NUMBER_OF_UNITS` | Returns number of units | Returns number of units matching the filter criteriaYou must have at least one of these scopes: 'units.read, setup.read, setup.manage'. |
| `APALEO_RETURN_TOTAL_COUNT_OF_PROPERTIES` | Return total count of properties | Return total count of propertiesYou need to be authorized (no particular scope required) |

## Supported Triggers

None listed.

## Creating MCP Server - Stand-alone vs Composio SDK

The Apaleo MCP server is an implementation of the Model Context Protocol that connects your AI agent to Apaleo. It provides structured and secure access so your agent can perform Apaleo operations on your behalf through a secure, permission-based interface.
With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster.

## Step-by-step Guide

### 1. Prerequisites

Before starting, make sure you have:
- Python 3.9 or higher
- A Composio account with an active API key
- Basic familiarity with Python and async programming

### 1. Getting API Keys for OpenAI and Composio

OpenAI API Key
- Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) 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
- Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs).
- Navigate to your API settings and generate a new API key.
- Store this key securely as you'll need it for authentication.

### 2. Install dependencies

Install the required libraries.
What's happening:
- composio connects your agent to external SaaS tools like Apaleo
- pydantic-ai lets you create structured AI agents with tool support
- python-dotenv loads your environment variables securely from a .env file
```bash
pip install composio pydantic-ai python-dotenv
```

### 3. Set up environment variables

Create a .env file in your project root.
What's happening:
- COMPOSIO_API_KEY authenticates your agent to Composio's API
- USER_ID associates your session with your account for secure tool access
- OPENAI_API_KEY to access OpenAI LLMs
```bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key
```

### 4. Import dependencies

What's happening:
- We load environment variables and import required modules
- Composio manages connections to Apaleo
- MCPServerStreamableHTTP connects to the Apaleo MCP server endpoint
- Agent from Pydantic AI lets you define and run the AI assistant
```python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()
```

### 5. Create a Tool Router Session

What's happening:
- We're creating a Tool Router session that gives your agent access to Apaleo tools
- The create method takes the user ID and specifies which toolkits should be available
- The returned session.mcp.url is the MCP server URL that your agent will use
```python
async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Apaleo
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["apaleo"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")
```

### 6. Initialize the Pydantic AI Agent

What's happening:
- The MCP client connects to the Apaleo endpoint
- The agent uses GPT-5 to interpret user commands and perform Apaleo operations
- The instructions field defines the agent's role and behavior
```python
# Attach the MCP server to a Pydantic AI Agent
apaleo_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
agent = Agent(
    "openai:gpt-5",
    toolsets=[apaleo_mcp],
    instructions=(
        "You are a Apaleo assistant. Use Apaleo tools to help users "
        "with their requests. Ask clarifying questions when needed."
    ),
)
```

### 7. Build the chat interface

What's happening:
- The agent reads input from the terminal and streams its response
- Apaleo API calls happen automatically under the hood
- The model keeps conversation history to maintain context across turns
```python
# Simple REPL with message history
history = []
print("Chat started! Type 'exit' or 'quit' to end.\n")
print("Try asking the agent to help you with Apaleo.\n")

while True:
    user_input = input("You: ").strip()
    if user_input.lower() in {"exit", "quit", "bye"}:
        print("\nGoodbye!")
        break
    if not user_input:
        continue

    print("\nAgent is thinking...\n", flush=True)

    async with agent.run_stream(user_input, message_history=history) as stream_result:
        collected_text = ""
        async for chunk in stream_result.stream_output():
            text_piece = None
            if isinstance(chunk, str):
                text_piece = chunk
            elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                text_piece = chunk.delta
            elif hasattr(chunk, "text"):
                text_piece = chunk.text
            if text_piece:
                collected_text += text_piece
        result = stream_result

    print(f"Agent: {collected_text}\n")
    history = result.all_messages()
```

### 8. Run the application

What's happening:
- The asyncio loop launches the agent and keeps it running until you exit
```python
if __name__ == "__main__":
    asyncio.run(main())
```

## Complete Code

```python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()

async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Apaleo
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["apaleo"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")

    # Attach the MCP server to a Pydantic AI Agent
    apaleo_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
    agent = Agent(
        "openai:gpt-5",
        toolsets=[apaleo_mcp],
        instructions=(
            "You are a Apaleo assistant. Use Apaleo tools to help users "
            "with their requests. Ask clarifying questions when needed."
        ),
    )

    # Simple REPL with message history
    history = []
    print("Chat started! Type 'exit' or 'quit' to end.\n")
    print("Try asking the agent to help you with Apaleo.\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "bye"}:
            print("\nGoodbye!")
            break
        if not user_input:
            continue

        print("\nAgent is thinking...\n", flush=True)

        async with agent.run_stream(user_input, message_history=history) as stream_result:
            collected_text = ""
            async for chunk in stream_result.stream_output():
                text_piece = None
                if isinstance(chunk, str):
                    text_piece = chunk
                elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                    text_piece = chunk.delta
                elif hasattr(chunk, "text"):
                    text_piece = chunk.text
                if text_piece:
                    collected_text += text_piece
            result = stream_result

        print(f"Agent: {collected_text}\n")
        history = result.all_messages()

if __name__ == "__main__":
    asyncio.run(main())
```

## Conclusion

You've built a Pydantic AI agent that can interact with Apaleo through Composio's Tool Router. With this setup, your agent can perform real Apaleo actions through natural language.
You can extend this further by:
- Adding other toolkits like Gmail, HubSpot, or Salesforce
- Building a web-based chat interface around this agent
- Using multiple MCP endpoints to enable cross-app workflows (for example, Gmail + Apaleo for workflow automation)
This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations.

## How to build Apaleo MCP Agent with another framework

- [OpenAI Agents SDK](https://composio.dev/toolkits/apaleo/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/apaleo/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/apaleo/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/apaleo/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/apaleo/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/apaleo/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/apaleo/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/apaleo/framework/cli)
- [Google ADK](https://composio.dev/toolkits/apaleo/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/apaleo/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/apaleo/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/apaleo/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/apaleo/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/apaleo/framework/crew-ai)

## Related Toolkits

- [Google Calendar](https://composio.dev/toolkits/googlecalendar) - Google Calendar is a time management service for scheduling meetings, events, and reminders. It streamlines personal and team organization with integrated notifications and sharing options.
- [Appointo](https://composio.dev/toolkits/appointo) - Appointo is an appointment booking platform for Shopify stores. It lets businesses add online scheduling to their websites with zero coding.
- [Bart](https://composio.dev/toolkits/bart) - Bart is the Bay Area Rapid Transit system, providing fast public transportation across the San Francisco Bay Area. It helps commuters and travelers get real-time schedule info, plan routes, and stay updated on service changes.
- [Bookingmood](https://composio.dev/toolkits/bookingmood) - Bookingmood is commission-free booking software for rental businesses. It lets you manage reservations and sync bookings directly on your website.
- [Booqable](https://composio.dev/toolkits/booqable) - Booqable is a rental software platform for managing inventory, bookings, and reservations. It helps businesses streamline rentals and keep track of every item with ease.
- [Cal](https://composio.dev/toolkits/cal) - Cal is a meeting scheduling platform that offers shareable booking links and real-time calendar syncing. It streamlines the process of finding mutual availability to make scheduling effortless.
- [Calendarhero](https://composio.dev/toolkits/calendarhero) - Calendarhero is a powerful scheduling platform that streamlines your calendar management across multiple services. It helps you efficiently schedule, reschedule, and organize meetings without the back-and-forth.
- [Calendly](https://composio.dev/toolkits/calendly) - Calendly is an appointment scheduling tool that automates meeting invitations, availability checks, and reminders. It helps individuals and teams avoid endless email back-and-forth when booking meetings.
- [Etermin](https://composio.dev/toolkits/etermin) - eTermin is an online appointment scheduling platform for businesses to manage bookings. It streamlines client appointments, saving time and reducing scheduling conflicts.
- [Evenium](https://composio.dev/toolkits/evenium) - Evenium is an all-in-one platform for managing professional events, from planning to analysis. It helps teams simplify event logistics, boost engagement, and track every detail in one place.
- [Eventee](https://composio.dev/toolkits/eventee) - Eventee is a user-friendly event management platform for mobile and web. It boosts attendee engagement for in-person, virtual, and hybrid events.
- [Eventzilla](https://composio.dev/toolkits/eventzilla) - Eventzilla is an event management platform for creating, promoting, and running events. It streamlines ticketing, registration, and attendee coordination for organizers.
- [Humanitix](https://composio.dev/toolkits/humanitix) - Humanitix is a not-for-profit ticketing platform that donates 100% of profits to charity. It empowers event organizers to make social impact with every ticket sold.
- [Lodgify](https://composio.dev/toolkits/lodgify) - Lodgify is an all-in-one vacation rental software for property managers and owners. It centralizes bookings, guest messaging, and channel synchronization in one dashboard.
- [Planyo Online Booking](https://composio.dev/toolkits/planyo_online_booking) - Planyo Online Booking is a flexible reservation system for managing bookings by day, hour, or event. It streamlines scheduling for any business needing reservations.
- [Scheduleonce](https://composio.dev/toolkits/scheduleonce) - Scheduleonce is a scheduling platform for capturing, qualifying, and engaging with inbound leads. It streamlines appointment booking and follow-ups for faster lead conversion.
- [Supersaas](https://composio.dev/toolkits/supersaas) - Supersaas is a flexible appointment scheduling platform for businesses and individuals. It streamlines bookings, reminders, and calendar management in one place.
- [Sympla](https://composio.dev/toolkits/sympla) - Sympla is a platform for managing in-person and online events, ticket sales, and registrations. It streamlines event setup, attendee tracking, and digital content delivery.
- [Gmail](https://composio.dev/toolkits/gmail) - Gmail is Google's email service with powerful spam protection, search, and G Suite integration. It keeps your inbox organized and makes communication fast and reliable.
- [Google Drive](https://composio.dev/toolkits/googledrive) - Google Drive is a cloud storage platform for uploading, sharing, and collaborating on files. It's perfect for keeping your documents accessible and organized across devices.

## Frequently Asked Questions

### What are the differences in Tool Router MCP and Apaleo MCP?

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.

### Can I use Tool Router MCP with Pydantic AI?

Yes, you can. Pydantic AI 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.

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

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.

### 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 Apaleo data and credentials are handled as safely as possible.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)