How to integrate Servicem8 MCP with OpenAI Agents SDK

Framework Integration Gradient
Servicem8 Logo
open-ai-agents-sdk Logo
divider

Introduction

This guide walks you through connecting Servicem8 to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Servicem8 agent that can create a new job for a plumbing callout, list all clients with overdue invoices, add a payment note to job 12345, show all available job document templates through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Servicem8 account through Composio's Servicem8 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 Servicem8
  • Configure an AI agent that can use Servicem8 as a tool
  • Run a live chat session where you can ask the agent to perform Servicem8 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 Servicem8 MCP server, and what's possible with it?

The Servicem8 MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Servicem8 account. It provides structured and secure access to your job management system, so your agent can perform actions like creating jobs, managing notes and payments, listing clients, and retrieving templates on your behalf.

  • Job creation and management: Instruct your agent to create new jobs, add detailed job information, or update records, streamlining field service operations.
  • Automated note handling: Have your agent attach important notes to jobs or remove outdated notes to keep job records clean and up-to-date.
  • Payment processing and tracking: Let your agent record new job payments or archive payment records, ensuring accurate and timely invoicing.
  • Comprehensive client and asset retrieval: Ask your agent to pull complete lists of clients and assets for reporting, integrations, or inventory management.
  • Template and form discovery: Fetch available document templates and forms so your agent can prepare job paperwork or gather required information efficiently.

Supported Tools & Triggers

Tools
ServiceM8 Create Job NoteTool to create a new job note in servicem8.
ServiceM8 Create Job PaymentTool to create a new job payment in servicem8.
Create a new JobTool to create a new job in servicem8.
Delete Job NoteTool to delete a specific job note.
ServiceM8 Delete Job PaymentTool to delete (archive) a specific job payment by its uuid.
List All AssetsTool to list all servicem8 assets.
List All ClientsTool to list all servicem8 clients.
List All Document TemplatesTool to list document templates.
List All FormsTool to list all servicem8 forms.
List All Job NotesTool to list all job notes in servicem8.
List All Job QueuesTool to list all job queues in servicem8.
List All JobsTool to list all jobs.
List All LocationsTool to list all servicem8 locations.
List All MaterialsTool to list all materials.
List All TasksTool to list all tasks in a servicem8 account.
Retrieve ServiceM8 ClientTool to retrieve details of a specific client by its uuid.
Retrieve FormTool to retrieve details of a specific form by its uuid.
Retrieve JobTool to retrieve details of a specific job by its uuid.
Retrieve Job ActivityTool to retrieve details of a specific job activity by its uuid.
Retrieve Job NoteTool to retrieve details of a specific job note by its uuid.
Retrieve Job PaymentTool to retrieve details of a specific job payment by its uuid.
Retrieve Job QueueTool to retrieve details of a specific job queue by its uuid.
Retrieve LocationTool to retrieve details of a specific location by its uuid.
Retrieve ServiceM8 MaterialTool to retrieve details of a specific material by its uuid.
Retrieve Staff MemberTool to retrieve details of a specific staff member by their uuid.
ServiceM8 Create JobTool to create a new job in servicem8.
Update a ServiceM8 Job NoteTool to update details of an existing job note.
ServiceM8 Update Job PaymentTool to update details of an existing job payment.

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

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 Servicem8 Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["servicem8"]
)

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 servicem8.
  • The router checks the user's Servicem8 connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Servicem8.
  • This approach keeps things lightweight and lets the agent request Servicem8 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 Servicem8. "
        "Help users perform Servicem8 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 Servicem8 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 Servicem8 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 Servicem8.
  • 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 Servicem8 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=["servicem8"]
)
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 Servicem8. "
        "Help users perform Servicem8 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 Servicem8 MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Servicem8.

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 Servicem8 MCP Agent with another framework

FAQ

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

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

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

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

Used by agents from

Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
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.