How to Use the Xray (Test Management) MCP in OpenAI Agents SDK

Q: Can the OpenAI Agents SDK list test plans for Xray (Test Management)?

Yep, you can use listtestplans to get a rundown of every configured plan. This gives your agent visibility into the project's testing scope at a glance.

Q: Does the OpenAI Agents SDK allow retrieving individual test runs for Xray (Test Management)?

Absolutely. The getindividualtestruns tool lets your agent drill down to specific instances of a single test, giving you detailed run history.

Q: How do I check settings for Xray (Test Management) with OpenAI Agents SDK?

You use getxraysettings to retrieve the project configuration and any field mappings. This is how your agent verifies that the system's underlying structure hasn't changed.

Build production testing pipelines with 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 Xray (Test Management) MCP to OpenAI Agents SDK

Create your Vinkius account to connect Xray (Test Management) 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 Xray (Test Management) with OpenAI Agents SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Get detailed test execution results.

The `get_execution_details` tool gives you granular results for a specific run. You can see exactly which tests passed, failed, or were skipped in the output. This is crucial when debugging complex quality assurance processes. It shows deep performance metrics that standard reports miss.

Manage test plans and configurations.

Need to know what's supposed to be tested? The `get_test_plan_details` tool pulls up all the details for a specific test plan. This includes scope, target build versions, and required setup steps. It lets your agent verify if the current testing environment matches expectations before running any tests.

List all available test cases.

Use `list_xray_tests` to pull a complete list of every test case in the Xray project. This is your agent's inventory—it knows what tests exist before it tries to run them. This capability helps build a dependency graph, letting you map out which tests relate to specific features.

Setup guide

Set up Xray (Test Management) 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 Xray (Test Management) tools at runtime.
3

Create your Agent

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

Run the agent

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

The SDK auto-discovers all available MCP tools, so you don't need to write any connection code. Your agent treats Xray like another set of APIs it can call natively within its workflow.

Yep, you can use `list_test_plans` to get a rundown of every configured plan. This gives your agent visibility into the project's testing scope at a glance.

This server handles test execution records, specific test case definitions, and overall project configurations. Basically, anything related to how tests are structured and run in Xray.

Absolutely. The `get_individual_test_runs` tool lets your agent drill down to specific instances of a single test, giving you detailed run history.

You use `get_xray_settings` to retrieve the project configuration and any field mappings. This is how your agent verifies that the system's underlying structure hasn't changed.

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