# How to integrate Maintainx MCP with OpenAI Agents SDK

```json
{
  "title": "How to integrate Maintainx MCP with OpenAI Agents SDK",
  "toolkit": "Maintainx",
  "toolkit_slug": "maintainx",
  "framework": "OpenAI Agents SDK",
  "framework_slug": "open-ai-agents-sdk",
  "url": "https://composio.dev/toolkits/maintainx/framework/open-ai-agents-sdk",
  "markdown_url": "https://composio.dev/toolkits/maintainx/framework/open-ai-agents-sdk.md",
  "updated_at": "2026-05-06T08:19:33.009Z"
}
```

## Introduction

This guide walks you through connecting Maintainx to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Maintainx agent that can create a new urgent work order for hvac, list all open work orders at warehouse, add comment to work order 12345 through natural language commands.
This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Maintainx account through Composio's Maintainx MCP server.
Before we dive in, let's take a quick look at the key ideas and tools involved.

## Also integrate Maintainx with

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

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

The Maintainx MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Maintainx account. It provides structured and secure access to your maintenance operations, so your agent can create work orders, update existing tasks, manage assets, and keep your teams aligned—automatically and on your behalf.
- Work order creation and management: Instantly have your agent create new work orders, add detailed descriptions, set priorities, and assign them to the right teams or users.
- Automated work order updates and comments: Let your agent update existing work orders or add comments for documentation and real-time communication between team members.
- Asset and location tracking: Effortlessly list and retrieve all assets and locations across your organization, helping you keep maintenance data organized and accessible.
- Category and team organization: Enable your agent to fetch and manage categories or teams, ensuring work orders and assets are classified and assigned correctly.
- Smart work request portals: Have your agent generate custom work request portals so stakeholders can submit maintenance requests easily and securely.

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `MAINTAINX_CREATE_WORK_ORDER` | Create Work Order | This tool creates a new work order in maintainx. it uses the post /api/v1/workorders endpoint. the tool requires a 'title' for the work order and offers several optional parameters including description, priority, duedate, startdate, userids, teamids, proceduretemplateid, locationid, assetid, and categories. |
| `MAINTAINX_CREATE_WORK_ORDER_COMMENT` | Create Work Order Comment | This tool creates a new comment on an existing work order in maintainx. it allows users to add comments for documentation, updates, or communication purposes within a specific work order. it requires a workorderid and the text content of the comment to create a new comment on the work order, providing capabilities to update maintenance work order records. |
| `MAINTAINX_CREATE_WORK_REQUEST_PORTAL` | Create Work Request Portal | Creates a new work request portal in maintainx. a work request portal allows users to submit work requests through a dedicated url. the portal can be customized with a title, welcome text, and description placeholder. it can be associated with a specific location and asset, and can be configured to require email contact information. |
| `MAINTAINX_FIND_ENTITY` | Find Entity | A tool to search and find specific entities within maintainx by specified fields. this tool allows users to search for different types of entities including work orders, users, and locations. |
| `MAINTAINX_LIST_ASSETS` | List Assets | This tool allows users to retrieve a list of all assets in their organization. |
| `MAINTAINX_LIST_CATEGORIES` | List Categories | This tool retrieves a list of all categories in your maintainx organization. categories are used to organize and classify work orders, assets, and other items in the system. it supports listing the categories with pagination and provides details such as category id, name, description, and timestamps for creation and update. |
| `MAINTAINX_LIST_LOCATIONS` | List Locations | This tool retrieves a list of all available locations in the organization's maintainx account. the locations can be physical places where assets are located, work is performed, or maintenance is needed. |
| `MAINTAINX_LIST_TEAMS` | List Teams | This tool retrieves a list of all teams in your maintainx organization. |
| `MAINTAINX_LIST_WORK_ORDERS` | List Work Orders | Action to list work orders from maintainx. |
| `MAINTAINX_UPDATE_WORK_ORDER` | Update Work Order | This tool allows users to update an existing work order in maintainx by modifying specific attributes without affecting other unchanged fields. it requires the workorder id and at least one of the optional parameters (title, description, or priority) to perform the update. |
| `MAINTAINX_UPDATE_WORK_ORDER_STATUS` | Update Work Order Status | This tool allows users to update the status of a specific work order in maintainx. it is focused specifically on status updates, making it more streamlined than the comprehensive 'update work order' action which allows updating multiple fields. |

## Supported Triggers

None listed.

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

The Maintainx MCP server is an implementation of the Model Context Protocol that connects your AI agent to Maintainx. It provides structured and secure access so your agent can perform Maintainx 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:
- Composio API Key and OpenAI API Key
- Primary know-how of OpenAI Agents SDK
- A live Maintainx project
- Some knowledge of Python or Typescript

### 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).
- Go to Settings and copy your API key.

### 2. Install dependencies

Install the Composio SDK and the OpenAI Agents SDK.
```python
pip install composio_openai_agents openai-agents python-dotenv
```

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

### 3. Set up environment variables

Create a .env file and add your OpenAI and Composio API keys.
```bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com
```

### 4. Import dependencies

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 Maintainx.
```python
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
```

```typescript
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';
```

### 5. Set up the Composio instance

No description provided.
```python
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())
```

```typescript
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(),
});
```

### 6. Create a Tool Router session

What is happening:
- You give the Tool Router the user id and the toolkits you want available. Here, it is only maintainx.
- The router checks the user's Maintainx connection and prepares the MCP endpoint.
- The returned session.mcp.url is the MCP URL that your agent will use to access Maintainx.
- This approach keeps things lightweight and lets the agent request Maintainx tools only when needed during the conversation.
```python
# Create a Maintainx Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["maintainx"]
)

mcp_url = session.mcp.url
```

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

### 7. Configure the agent

No description provided.
```python
# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Maintainx. "
        "Help users perform Maintainx 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",
            }
        )
    ],
)
```

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

### 8. Start chat loop and handle conversation

No description provided.
```python
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())
```

```typescript
// 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);
});
```

## Complete Code

```python
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=["maintainx"]
)
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 Maintainx. "
        "Help users perform Maintainx 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())
```

```typescript
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: ['maintainx'],
  });
  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 Maintainx. Help users perform Maintainx 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 Maintainx MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Maintainx.
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 Maintainx MCP Agent with another framework

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

## Related Toolkits

- [Apilio](https://composio.dev/toolkits/apilio) - Apilio is a home automation platform that lets you connect and control smart devices from different brands. It helps you build flexible automations with complex conditions, schedules, and integrations.
- [Basin](https://composio.dev/toolkits/basin) - Basin is a no-code form backend for quickly setting up reliable contact forms. It lets you collect and manage form submissions without writing any server-side code.
- [Bouncer](https://composio.dev/toolkits/bouncer) - Bouncer is an email validation platform that verifies the authenticity of email addresses in real-time and batch. It helps boost deliverability and reduce bounce rates for your communications.
- [Conveyor](https://composio.dev/toolkits/conveyor) - Conveyor is a platform that automates security reviews with a Trust Center and AI-driven questionnaire automation. It streamlines compliance and vendor security processes for faster, hassle-free reviews.
- [Crowdin](https://composio.dev/toolkits/crowdin) - Crowdin is a localization management platform that streamlines translation workflows and collaboration. It helps teams centralize multilingual content, boost productivity, and automate translation processes.
- [Databox](https://composio.dev/toolkits/databox) - Databox is a business analytics platform that connects your data from any tool and device. It helps you track KPIs, build dashboards, and discover actionable insights.
- [Detrack](https://composio.dev/toolkits/detrack) - Detrack is a delivery management platform for real-time tracking and proof of delivery. It helps businesses automate notifications and keep customers updated every step of the way.
- [Dnsfilter](https://composio.dev/toolkits/dnsfilter) - Dnsfilter is a cloud-based DNS security and content filtering solution. It helps organizations block online threats and manage safe internet access with ease.
- [Faraday](https://composio.dev/toolkits/faraday) - Faraday lets you embed AI in workflows across your stack for smarter automation. It boosts your favorite tools with actionable intelligence and seamless integration.
- [Feathery](https://composio.dev/toolkits/feathery) - Feathery is an AI-powered platform for building dynamic data intake forms with advanced logic. It helps teams automate complex workflows and collect structured data with ease.
- [Fillout forms](https://composio.dev/toolkits/fillout_forms) - Fillout forms is an online platform for building and managing forms with a flexible API. It lets you create, distribute, and collect responses from forms with ease.
- [Formdesk](https://composio.dev/toolkits/formdesk) - Formdesk is an online form builder for creating and managing professional forms. It's perfect for collecting data, automating workflows, and integrating form submissions with your favorite services.
- [Formsite](https://composio.dev/toolkits/formsite) - Formsite lets you build online forms and surveys with drag-and-drop simplicity. Capture, manage, and integrate form responses securely for streamlined workflows.
- [Graphhopper](https://composio.dev/toolkits/graphhopper) - GraphHopper is an enterprise-grade Directions API for routing, optimization, and geocoding across multiple vehicle types. It enables fast, reliable route planning and logistics automation for businesses.
- [Hyperbrowser](https://composio.dev/toolkits/hyperbrowser) - Hyperbrowser is a next-generation platform for scalable browser automation. It empowers AI agents to interact with web apps, automate workflows, and handle browser sessions at scale.
- [La Growth Machine](https://composio.dev/toolkits/lagrowthmachine) - La Growth Machine automates multi-channel sales outreach and routine tasks for sales teams. Streamline your workflow and focus on closing more deals.
- [Leverly](https://composio.dev/toolkits/leverly) - Leverly is a workflow automation platform that connects and coordinates actions across your apps. It streamlines repetitive processes so your business runs smoother, faster, and with fewer manual steps.
- [Make](https://composio.dev/toolkits/make) - Make is an automation platform that connects your favorite apps and services. Build powerful, custom workflows without writing code.
- [Ntfy](https://composio.dev/toolkits/ntfy) - Ntfy is a notification service to send push messages to phones or desktops. Instantly deliver alerts and updates to users, devices, or teams.
- [Persona](https://composio.dev/toolkits/persona) - Persona offers identity infrastructure to automate user verification and compliance. It helps organizations securely verify users and reduce fraud risk.

## Frequently Asked Questions

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

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

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

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

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