How to Use the Yida MCP in OpenAI Agents SDK

Q: How do I manage data instances with Yida using OpenAI Agents SDK?

Your agent first uses listdataids to get a list of available IDs. Then, it passes those specific IDs into the getrecorddetails toolset. This retrieves the full payload for each record you care about.

Q: Does Yida support listing multiple forms using OpenAI Agents SDK?

Yes. The agent calls listforms, which immediately provides a list of all available forms in your Yida application. This is the starting point for any form-related action.

Q: How does Yida handle schema retrieval when using OpenAI Agents SDK?

You use the getformschema tool to pull the field structure for any given form. This tells your agent exactly what input format is required before it attempts to create or update data.

Build production agents with OpenAI Agents SDK. Manage Yida form data and workflows reliably.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Yida MCP to OpenAI Agents SDK

Create your Vinkius account to connect Yida 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 Yida with OpenAI Agents SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Reading Form Structures with MCP Server

Need to know what fields a user needs? Use `get_form_schema` to fetch the exact structure of any Yida form. This tells your agent precisely which data points are available, keeping your workflow accurate. It's better than guessing. By understanding the schema first, you can then confidently use tools like `create_record` or `update_record`, knowing exactly what format those services expect.

Managing Yida User and Form Inventory

When your agent needs context about the environment, start by listing assets. The `list_forms` tool shows every form available in the Yida application. You can pair this with `list_users` to map out who has access to what. This visibility is critical for building multi-step processes. Knowing all forms and users helps your agent determine which data streams it needs to read or modify.

Tracking Workflow Progress via MCP Server

Approvals take time, so you need to know where a record stands. The `get_instance_timeline` tool retrieves the full history of any workflow instance. You get timestamps and details for every handoff or status change. This lets your agent build a true audit trail. It moves beyond just knowing if an update happened; it tells you *when* and *by whom* the record was modified.

Setup guide

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

Create your Agent

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

Run the agent

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

Your agent first uses `list_data_ids` to get a list of available IDs. Then, it passes those specific IDs into the `get_record_details` toolset. This retrieves the full payload for each record you care about.

Yes. The agent calls `list_forms`, which immediately provides a list of all available forms in your Yida application. This is the starting point for any form-related action.

The MCP Server handles Form Records, Workflow Instances, and Application Users. You'll be dealing with structured data that includes field values, status changes, and user identifiers.

You must first identify the specific ID of the record. The agent uses this ID with the `delete_record` tool. This ensures that only targeted data is removed.

You use the `get_form_schema` tool to pull the field structure for any given form. This tells your agent exactly what input format is required before it attempts to create or update 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