How to Use the Franchimp MCP in OpenAI Agents SDK
Build production-ready franchise intelligence agents that work safely with the OpenAI Agents SDK. No surprises.
Works with every AI agent you already use
…and any MCP-compatible client
Connect Franchimp MCP to OpenAI Agents SDK
Create your Vinkius account to connect Franchimp 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.
Find and Vet Multi-Unit Operators
Use `list_multi_unit_operators` to get a list of potential leads. Your agent can then automatically loop through them, calling `get_franchisee_details` for contact info and `get_investment_stats` to check their financial history. The OpenAI SDK's guardrails are key here. You can set rules to prevent the agent from acting on incomplete data or from contacting operators below a certain capital threshold. It's lead gen with a safety net.
Run Due Diligence with the OpenAI Agents SDK
Your agent can start with a broad `search_franchisors` query, then dig into specific results using `get_franchise_details`. It can pull all related Franchise Disclosure Documents with `list_fdd_documents` and check their metadata with `get_fdd_metadata`. With the OpenAI dashboard, you can trace every single step. You'll see exactly which tools the agent called and what data it got back. This makes debugging complex research chains way easier.
Manage Usage and Credits
Before running a big job, your agent can call `list_available_credits` to make sure you don't run out mid-task. It's a simple check to avoid failed runs when you're pulling a lot of FDDs. You can even build a specialized agent just for account monitoring. It can periodically use `get_account_info` and the credit check tool, then hand off to another agent to send a notification if credits are low. That's the power of agent handoffs.
Set up Franchimp MCP in OpenAI Agents SDK
Prerequisites
- Python 3.10+ installed
-
openai-agentspackage (pip install openai-agents) - Active Vinkius subscription with a valid endpoint token
- 1
Install the SDK
Run
pip install openai-agentsto install the OpenAI Agents SDK. The MCP integration is built-in — no extra dependencies needed. - 2
Connect via SSE transport
Use
MCPServerSsewith your Vinkius endpoint URL. Replace[YOUR_TOKEN_HERE]with your token from cloud.vinkius.com. The SDK auto-discovers all Franchimp tools at runtime. - 3
Create your Agent
Pass the MCP to
Agent(mcp_servers=[server]). The agent receives Franchimp tools as native definitions — JSON schemas resolve automatically. - 4
Run the agent
Call
Runner.run(agent, prompt)to execute. The agent invokes the appropriate Franchimp tools and returns structured results. Copy the full example on the right to get started.
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="Franchimp Agent",
instructions="You have access to Franchimp tools.",
mcp_servers=[server],
)
result = await Runner.run(agent, "List recent transactions")
print(result.final_output)
asyncio.run(main()) Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by Franchimp. 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.
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 Franchimp MCP in OpenAI Agents SDK
Use it with your favorite AI tools
Connect this server to Cursor, Claude, VS Code, and more.
Start using the Franchimp MCP today
We host it, we monitor it, we maintain it. You just paste one token.