How to Use the Serviceform MCP in OpenAI Agents SDK

Q: How do I check lead details using Serviceform with OpenAI Agents SDK?

To get lead details, your agent calls getlead. The tool uses the provided identifiers to fetch specific information about a captured user. This helps you validate the data before passing it down the pipeline.

Q: Can I use Serviceform with OpenAI Agents SDK to list available forms?

Yep, just run listforms. This command tells your agent every active form available for lead capture. It’s a great way to audit what data the system can collect right now.

Q: Does Serviceform with OpenAI Agents SDK help discover available spaces?

Yes, run listspaces to see what 'flex spaces' are configured. This gives your agent a clear map of where content or widgets can be placed on the site.

Convert visitors and capture data using Serviceform with OpenAI Agents SDK.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers — Included with Plan

Connect Serviceform MCP to OpenAI Agents SDK

Create your Vinkius account to connect Serviceform to OpenAI Agents SDK — we handle the hosting, security, and runtime updates so you don't have to. No server setup required.

GDPR Included with Plan

Setup Serviceform with OpenAI Agents SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity Vinkius runs on Gemini

Gemini

Grok

Check live chat history

Need to review past interactions? Use `list_chats` by passing criteria as a JSON string. This lets your agent pull specific chat histories based on what you define. The agent handles this call, giving you visibility into customer journeys before the sale. It’s crucial for diagnosing why leads dropped off.

List all active forms

Your system needs to know which data points are available? Call `list_forms` to get a list of every form currently running on your site. This gives the agent an inventory of data collection tools. The agent knows exactly what fields and rules apply before trying to capture any lead information, preventing bad calls.

Retrieve specific lead details

When a conversion happens, you need the raw data. The `get_lead` tool retrieves full details for a captured lead. This action gives your agent all necessary context on who signed up and how. This is key for handoffs. Your specialized agents can take those detailed inputs—like email or company size—and immediately pass them to sales.

Setup guide

Set up Serviceform 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 Serviceform tools at runtime.
3

Create your Agent

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

Run the agent

Call Runner.run(agent, prompt) to execute. The agent invokes the appropriate Serviceform 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="Serviceform Agent",
            instructions="You have access to Serviceform 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 Serviceform. 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 Serviceform 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 Serviceform MCP in OpenAI Agents SDK

To get lead details, your agent calls `get_lead`. The tool uses the provided identifiers to fetch specific information about a captured user. This helps you validate the data before passing it down the pipeline.

Yep, just run `list_forms`. This command tells your agent every active form available for lead capture. It’s a great way to audit what data the system can collect right now.

You pass specific search parameters as a JSON string when calling `list_chats`. This lets your agent narrow down massive amounts of data to find exactly the conversations you care about.

Yes, run `list_spaces` to see what 'flex spaces' are configured. This gives your agent a clear map of where content or widgets can be placed on the site.

The server touches PII (Personally Identifiable Information) through tools like `get_lead` and `list_chats`. Always ensure your agent's guardrails validate who can access this sensitive user data.

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