How to integrate Servicem8 MCP with OpenAI Agents SDK

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

Servicem8 logoServicem8
Oauth2

Servicem8 is a field service management platform for scheduling jobs, quoting, and invoicing. It helps businesses track real-time job status and empower mobile staff in the field.

28 Tools

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

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

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 Servicem8 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 Servicem8.
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 Servicem8
const session = await composio.create(userId as string, {
  toolkits: ['servicem8'],
});
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 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.
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 Servicem8. Help users perform Servicem8 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 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 object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Servicem8 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 Servicem8.
  • 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 Servicem8 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: ['servicem8'],
  });
  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 Servicem8. Help users perform Servicem8 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 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.
TOOLS

Supported Tools

Every Servicem8 action and event your agent gets out of the box.

ServiceM8 Create Job Note

Create a new job note in ServiceM8.

ServiceM8 Create Job Payment

Tool to create a new job payment in ServiceM8.

Create a new Job

Tool to create a new Job in ServiceM8.

Delete Custom Field

Delete a custom field in ServiceM8 by its UUID.

Delete Job Note

Deletes (archives) a job note in ServiceM8 by its UUID.

Delete Job Payment

Archives (soft-deletes) a job payment record in ServiceM8 by its UUID.

List All Assets

Tool to list all ServiceM8 assets.

List All Clients

Tool to list all ServiceM8 clients.

List All Document Templates

Tool to list document templates.

List All Forms

Tool to list all ServiceM8 forms.

List All Job Notes

List all job notes from ServiceM8.

List All Job Queues

List all job queues in ServiceM8.

List All Jobs

Tool to list all jobs.

List All Locations

Lists all ServiceM8 locations.

List All Materials

Retrieve all materials (products, labour rates, inventory items) from ServiceM8.

List All Tasks

Retrieves all tasks from a ServiceM8 account with optional filtering and cursor-based pagination.

Retrieve ServiceM8 Client

Tool to retrieve details of a specific client by its UUID.

Retrieve Form

Retrieve details of a specific form template by its UUID.

Retrieve Job

Tool to retrieve details of a specific job by its UUID.

Retrieve Job Activity

Tool to retrieve details of a specific job activity by its UUID.

Retrieve Job Note

Retrieve the full details of a specific job note by its UUID.

Retrieve Job Payment

Retrieve a specific job payment record from ServiceM8 by its UUID.

Retrieve Job Queue

Tool to retrieve details of a specific job queue by its UUID.

Retrieve Location

Retrieve a specific ServiceM8 location by its UUID.

Retrieve ServiceM8 Material

Retrieve detailed information about a specific material/product/service by its UUID.

Retrieve Staff Member

Tool to retrieve details of a specific staff member by their UUID.

Update a ServiceM8 Job Note

Tool to update details of an existing job note.

Update Job Payment

Update an existing job payment record in ServiceM8.

FAQ

Frequently asked questions

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.

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.

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.

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.

Start with Servicem8.It takes 30 seconds.

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

Start building