How to Use the WorkWave MCP in OpenAI Agents SDK

Q: How do I verify WorkWave API connectivity with the OpenAI Agents SDK?

You call getapihealth to check if the connection is up. This confirms that your agent can reliably talk to WorkWave before running a critical task.

Q: Can I list all available locations using WorkWave and OpenAI Agents SDK?

Absolutely. The listservicelocations tool lets your agent pull a complete list of physical service sites or job locations registered in the system.

Build Production Agents with WorkWave and the OpenAI Agents SDK.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect WorkWave MCP to OpenAI Agents SDK

Create your Vinkius account to connect WorkWave to OpenAI Agents SDK and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup WorkWave with OpenAI Agents SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Managing Service Orders via MCP Server

The `update_order_status` tool lets your agent change a service order's lifecycle status. It can mark an order as Pending, InProgress, or Completed immediately. You’ll also need to check the current details using `get_order_details`. This combination ensures that any workflow touching job statuses has full visibility and control.

Listing Field Staff Details

Want to find out who's available? Your agent can fetch technician listings with the `list_field_employees` tool. It retrieves all field staff registered within WorkWave. Keep in mind it also knows how to list customer accounts through `list_field_service_accounts`. This helps your agent segment which employees serve specific client groups.

Getting Customer and Asset Data

Need information on a client? Use the `get_account_details` tool to pull up specifics for any customer account. You can also list managed equipment assets using `list_service_equipment`. This means your agent doesn't just know about people; it knows what gear they are responsible for and where it is located.

Setup guide

Set up WorkWave MCP in OpenAI Agents SDK

Prerequisites

Python 3.10+ installed
openai-agents package (pip install openai-agents)
Active Vinkius subscription with a valid endpoint token

1

Install the SDK

Run pip install openai-agents to install the OpenAI Agents SDK. The MCP integration is built-in — no extra dependencies needed.
2

Connect via SSE transport

Use MCPServerSse with your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. The SDK auto-discovers all WorkWave tools at runtime.
3

Create your Agent

Pass the MCP to Agent(mcp_servers=[server]). The agent receives WorkWave tools as native definitions — JSON schemas resolve automatically.
4

Run the agent

Call Runner.run(agent, prompt) to execute. The agent invokes the appropriate WorkWave tools and returns structured results. Copy the full example on the right to get started.

agent.py

import asyncio
from agents import Agent, Runner
from agents.mcp import MCPServerSse

async def main():
    async with MCPServerSse(
        url="https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    ) as server:
        agent = Agent(
            name="WorkWave Agent",
            instructions="You have access to WorkWave tools.",
            mcp_servers=[server],
        )
        result = await Runner.run(agent, "List recent transactions")
        print(result.final_output)

asyncio.run(main())

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by WorkWave. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect WorkWave now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about WorkWave MCP in OpenAI Agents SDK

You call `get_api_health` to check if the connection is up. This confirms that your agent can reliably talk to WorkWave before running a critical task.

Yes, it does. You can manage service orders and customer accounts using tools like `list_service_orders` or `get_account_details`. The agent handles the sequence of calls for you.

The server touches core field service data, including customer accounts, job sites (`list_service_locations`), and service orders. These are the primary data points you'll be working with.

Absolutely. The `list_service_locations` tool lets your agent pull a complete list of physical service sites or job locations registered in the system.

This MCP Server handles customer account details. When designing your production agents, always remember that you're dealing with sensitive client information.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript