# How to integrate Servicem8 MCP with Pydantic AI ```json { "title": "How to integrate Servicem8 MCP with Pydantic AI", "toolkit": "Servicem8", "toolkit_slug": "servicem8", "framework": "Pydantic AI", "framework_slug": "pydantic-ai", "url": "https://composio.dev/toolkits/servicem8/framework/pydantic-ai", "markdown_url": "https://composio.dev/toolkits/servicem8/framework/pydantic-ai.md", "updated_at": "2026-05-12T10:25:40.879Z" } ``` ## Introduction This guide walks you through connecting Servicem8 to Pydantic AI 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 Pydantic AI 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 - [OpenAI Agents SDK](https://composio.dev/toolkits/servicem8/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/servicem8/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/servicem8/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/servicem8/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/servicem8/framework/codex) - [OpenClaw](https://composio.dev/toolkits/servicem8/framework/openclaw) - [Hermes](https://composio.dev/toolkits/servicem8/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/servicem8/framework/cli) - [Google ADK](https://composio.dev/toolkits/servicem8/framework/google-adk) - [LangChain](https://composio.dev/toolkits/servicem8/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/servicem8/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/servicem8/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/servicem8/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/servicem8/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 Servicem8 - 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 Servicem8 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 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 | Tool slug | Name | Description | |---|---|---| | `SERVICEM8_CREATE_JOB_NOTE` | ServiceM8 Create Job Note | Create a new job note in ServiceM8. Requires the job's UUID (related_object_uuid) and the note content. Returns the UUID of the created note record. Use this to add comments, updates, or action items to a specific job. | | `SERVICEM8_CREATE_JOB_PAYMENT` | ServiceM8 Create Job Payment | Tool to create a new job payment in ServiceM8. Use when you have collected payment details and need to record payment against a job. Example: "Create a 100.00 cash payment for job 123e4567-e89b-12d3-a456-426614174000 at 2023-01-01 13:00:00." | | `SERVICEM8_CREATE_JOBS` | Create a new Job | Tool to create a new Job in ServiceM8. Use when you have gathered all job details and need to push a record. Example: "Create a Quote job for 123 Main St with PO #1234." | | `SERVICEM8_DELETE_CUSTOM_FIELD` | Delete Custom Field | Delete a custom field in ServiceM8 by its UUID. Use this when you need to permanently remove a custom field definition from the system. This will remove the custom field and any associated data. | | `SERVICEM8_DELETE_JOB_NOTE` | Delete Job Note | Deletes (archives) a job note in ServiceM8 by its UUID. Use this tool when you need to remove a note from a job's diary. In ServiceM8, deletion is a soft-delete: the note is archived (active=0) rather than permanently removed, and can be restored later if needed. Prerequisites: You need the note's UUID, which can be obtained from the 'List All Job Notes' or 'Retrieve Job Note' actions. | | `SERVICEM8_DELETE_JOB_PAYMENT` | Delete Job Payment | Archives (soft-deletes) a job payment record in ServiceM8 by its UUID. In ServiceM8, records are never permanently deleted. Instead, deletion sets the record's 'active' field to 0, which hides it from the UI but keeps it accessible via the API. Archived records can be restored by setting their 'active' field back to 1. Use this tool when you need to remove a payment record from active use, such as when a payment was recorded in error or needs to be voided. Requires the 'manage_job_payments' OAuth scope. | | `SERVICEM8_LIST_ALL_ASSETS` | List All Assets | Tool to list all ServiceM8 assets. Use when you need a comprehensive asset registry, including custom fields, for inventory or reporting. | | `SERVICEM8_LIST_ALL_CLIENTS` | List All Clients | Tool to list all ServiceM8 clients. Use when you need a complete set of customer records for integrations or reporting. | | `SERVICEM8_LIST_ALL_DOCUMENT_TEMPLATES` | List All Document Templates | Tool to list document templates. Use when you need to retrieve available template UUIDs and names before generating job documents. | | `SERVICEM8_LIST_ALL_FORMS` | List All Forms | Tool to list all ServiceM8 forms. Use when you need to fetch available form templates with optional filters. | | `SERVICEM8_LIST_ALL_JOB_NOTES` | List All Job Notes | List all job notes from ServiceM8. Use this tool to: - Retrieve all notes across all jobs (no filter) - Get notes for a specific job using filter: "related_object_uuid eq ''" - Filter by active status: "active eq 1" for active notes only The response contains a list of note records with their content, timestamps, and associated job UUIDs. For large result sets, use cursor-based pagination: pass cursor='-1' for the first page, then use the 'next_cursor' value from each response to fetch subsequent pages. Each page returns up to 5,000 records. | | `SERVICEM8_LIST_ALL_JOB_QUEUES` | List All Job Queues | List all job queues in ServiceM8. Job queues are virtual folders for organizing jobs on hold. Use this to fetch available queues before assigning jobs to a queue, or to check queue configurations. Returns both regular queues (for jobs waiting on external actions) and assignable queues (for staff assignments). | | `SERVICEM8_LIST_ALL_JOBS` | List All Jobs | Tool to list all jobs. Use when you need to fetch all job records from your ServiceM8 account. | | `SERVICEM8_LIST_ALL_LOCATIONS` | List All Locations | Lists all ServiceM8 locations. Use to fetch configured service areas, office locations, or warehouses for job assignments, mapping, or reporting. | | `SERVICEM8_LIST_ALL_MATERIALS` | List All Materials | Retrieve all materials (products, labour rates, inventory items) from ServiceM8. Use this to get a complete catalog of materials for quoting, invoicing, or inventory management. Requires the 'read_inventory' OAuth scope. | | `SERVICEM8_LIST_ALL_TASKS` | List All Tasks | Retrieves all tasks from a ServiceM8 account with optional filtering and cursor-based pagination. Use this to fetch task records, track task assignments, monitor completion status, or sync task data. Requires 'read_tasks' OAuth scope. | | `SERVICEM8_RETRIEVE_CLIENT` | Retrieve ServiceM8 Client | Tool to retrieve details of a specific client by its UUID. Use after confirming the client's UUID is valid. | | `SERVICEM8_RETRIEVE_FORM` | Retrieve Form | Retrieve details of a specific form template by its UUID. Use this tool when you have a form UUID and need to fetch its metadata, such as form name, description, and status. Requires the Forms add-on to be enabled in ServiceM8. | | `SERVICEM8_RETRIEVE_JOB` | Retrieve Job | Tool to retrieve details of a specific job by its UUID. Use when you have the Job UUID and need its full record. | | `SERVICEM8_RETRIEVE_JOB_ACTIVITY` | Retrieve Job Activity | Tool to retrieve details of a specific job activity by its UUID. Use when you have the job activity UUID and need its full details. | | `SERVICEM8_RETRIEVE_JOB_NOTE` | Retrieve Job Note | Retrieve the full details of a specific job note by its UUID. Use this action when you have a note UUID (e.g., from listing job notes) and need to view its complete record including content, timestamps, and the associated job reference. | | `SERVICEM8_RETRIEVE_JOB_PAYMENT` | Retrieve Job Payment | Retrieve a specific job payment record from ServiceM8 by its UUID. Use this tool when you need to: - Get full details of a specific payment (amount, method, timestamp, notes) - Check if a payment is a deposit or regular payment - View which staff member processed a payment - Verify payment information for a job Prerequisites: You need the job payment UUID, which can be obtained from the 'List All Job Payments' action or from creating a new job payment. | | `SERVICEM8_RETRIEVE_JOB_QUEUE` | Retrieve Job Queue | Tool to retrieve details of a specific job queue by its UUID. Use when you need full queue metadata before dispatching work. | | `SERVICEM8_RETRIEVE_LOCATION` | Retrieve Location | Retrieve a specific ServiceM8 location by its UUID. Returns complete location details including name, address fields (street, city, state, country, postal code), geographic coordinates (lat/lng), contact phone number, and active status. Use this when you have a known location UUID and need its full details. To list all available locations, use the List All Locations action first. | | `SERVICEM8_RETRIEVE_MATERIAL` | Retrieve ServiceM8 Material | Retrieve detailed information about a specific material/product/service by its UUID. Returns pricing, inventory levels, tax settings, and identification details. Use this when you have a material UUID from a job or list operation and need complete details like current stock levels or pricing information. | | `SERVICEM8_RETRIEVE_STAFF_MEMBER` | Retrieve Staff Member | Tool to retrieve details of a specific staff member by their UUID. Use when you need up-to-date staff information given a known staff UUID. | | `SERVICEM8_UPDATE_JOB_NOTE` | Update a ServiceM8 Job Note | Tool to update details of an existing job note. Use when modifying a note after its creation. | | `SERVICEM8_UPDATE_JOB_PAYMENT` | Update Job Payment | Update an existing job payment record in ServiceM8. Use this to modify payment details such as amount, method, note, or status. Requires the payment UUID and at least one field to update. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Servicem8 MCP server is an implementation of the Model Context Protocol that connects your AI agent to Servicem8. It provides structured and secure access so your agent can perform Servicem8 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 Servicem8 - 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 Servicem8 - MCPServerStreamableHTTP connects to the Servicem8 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 Servicem8 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 Servicem8 composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["servicem8"], ) 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 Servicem8 endpoint - The agent uses GPT-5 to interpret user commands and perform Servicem8 operations - The instructions field defines the agent's role and behavior ```python # Attach the MCP server to a Pydantic AI Agent servicem8_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[servicem8_mcp], instructions=( "You are a Servicem8 assistant. Use Servicem8 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 - Servicem8 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 Servicem8.\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 Servicem8 composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["servicem8"], ) 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 servicem8_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[servicem8_mcp], instructions=( "You are a Servicem8 assistant. Use Servicem8 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 Servicem8.\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 Servicem8 through Composio's Tool Router. With this setup, your agent can perform real Servicem8 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 + Servicem8 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 Servicem8 MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/servicem8/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/servicem8/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/servicem8/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/servicem8/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/servicem8/framework/codex) - [OpenClaw](https://composio.dev/toolkits/servicem8/framework/openclaw) - [Hermes](https://composio.dev/toolkits/servicem8/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/servicem8/framework/cli) - [Google ADK](https://composio.dev/toolkits/servicem8/framework/google-adk) - [LangChain](https://composio.dev/toolkits/servicem8/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/servicem8/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/servicem8/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/servicem8/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/servicem8/framework/crew-ai) ## Related Toolkits - [Google Sheets](https://composio.dev/toolkits/googlesheets) - Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly. - [Notion](https://composio.dev/toolkits/notion) - Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place. - [Airtable](https://composio.dev/toolkits/airtable) - Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations. - [Asana](https://composio.dev/toolkits/asana) - Asana is a collaborative work management platform for teams to organize and track projects. It streamlines teamwork, boosts productivity, and keeps everyone aligned on goals. - [Google Tasks](https://composio.dev/toolkits/googletasks) - Google Tasks is a to-do list and task management tool integrated into Gmail and Google Calendar. It helps you organize, track, and complete tasks across your Google ecosystem. - [Linear](https://composio.dev/toolkits/linear) - Linear is a modern issue tracking and project planning tool for fast-moving teams. It helps streamline workflows, organize projects, and boost productivity. - [Jira](https://composio.dev/toolkits/jira) - Jira is Atlassian’s platform for bug tracking, issue tracking, and agile project management. It helps teams organize work, prioritize tasks, and deliver projects efficiently. - [Clickup](https://composio.dev/toolkits/clickup) - ClickUp is an all-in-one productivity platform for managing tasks, docs, goals, and team collaboration. It streamlines project workflows so teams can work smarter and stay organized in one place. - [Monday](https://composio.dev/toolkits/monday) - Monday.com is a customizable work management platform for project planning and collaboration. It helps teams organize tasks, automate workflows, and track progress in real time. - [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time. - [Agiled](https://composio.dev/toolkits/agiled) - Agiled is an all-in-one business management platform for CRM, projects, and finance. It helps you streamline workflows, consolidate client data, and manage business processes in one place. - [Ascora](https://composio.dev/toolkits/ascora) - Ascora is a cloud-based field service management platform for service businesses. It streamlines scheduling, invoicing, and customer operations in one place. - [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place. - [Beeminder](https://composio.dev/toolkits/beeminder) - Beeminder is an online goal-tracking platform that uses monetary pledges to keep you motivated. Stay accountable and hit your targets with real financial incentives. - [Boxhero](https://composio.dev/toolkits/boxhero) - Boxhero is a cloud-based inventory management platform for SMBs, offering real-time updates, barcode scanning, and team collaboration. It helps businesses streamline stock tracking and analytics for smarter inventory decisions. - [Breathe HR](https://composio.dev/toolkits/breathehr) - Breathe HR is cloud-based HR software for SMEs to manage employee data, absences, and performance. It simplifies HR admin, making it easy to keep employee records accurate and up to date. - [Breeze](https://composio.dev/toolkits/breeze) - Breeze is a project management platform designed to help teams plan, track, and collaborate on projects. It streamlines workflows and keeps everyone on the same page. - [Bugherd](https://composio.dev/toolkits/bugherd) - Bugherd is a visual feedback and bug tracking tool for websites. It helps teams and clients report website issues directly on live sites for faster fixes. - [Canny](https://composio.dev/toolkits/canny) - Canny is a platform for managing customer feedback and feature requests. It helps teams prioritize product decisions based on real user insights. - [Chmeetings](https://composio.dev/toolkits/chmeetings) - Chmeetings is a church management platform for events, members, donations, and volunteers. It streamlines church operations and improves community engagement. ## Frequently Asked Questions ### 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 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 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. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)