How to Use the Northbeam MCP in OpenAI Agents SDK

Q: How does the OpenAI Agents SDK use Northbeam to create reports?

Your agent discovers tools like createdataexport automatically. You can task it to combine specific metrics and breakdowns from Northbeam, and the SDK will handle calling the MCP server to generate the report.

Q: How do I check the status of a Northbeam data export with my OpenAI agent?

Your agent can call the getexportstatus tool with the export ID. The OpenAI dashboard provides a full trace of these interactions, so you can see the agent's entire monitoring process.

Connect your OpenAI Agent to Northbeam for production-ready attribution analysis. Guardrails prevent bad API calls before they happen.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Northbeam MCP to OpenAI Agents SDK

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

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Build Safe Attribution Workflows

Your agent can now build custom attribution reports. It uses `list_attribution_models` and `list_breakdowns` to find the right combination, then triggers an export with `create_data_export`. The OpenAI SDK's built-in guardrails mean you can deploy this with confidence. Before your agent ever calls `create_data_export`, the SDK validates the action. This prevents costly mistakes or accidental data pulls in a production environment.

Trace Every Step of Your Analysis

Stop guessing what your agent did. Let it monitor Northbeam export jobs by polling `get_export_status` and listing completed files with `list_recent_exports`. Because you're using the OpenAI Agents SDK, every one of these calls is logged and traced in your OpenAI dashboard. You get a full audit trail, perfect for debugging or showing stakeholders exactly how a report was generated.

Manage Settings with your MCP Server

Your agent can check current account configurations on the fly. It uses `get_account_info` to confirm account metadata and `get_dashboard_settings` to see how the workspace is set up. This is critical for multi-agent systems. One agent can verify settings while another prepares a data export, with the OpenAI framework managing the handoff. It ensures your reporting agents are always working with the right context.

Setup guide

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

Create your Agent

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

Run the agent

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

Your agent discovers tools like `create_data_export` automatically. You can task it to combine specific metrics and breakdowns from Northbeam, and the SDK will handle calling the MCP server to generate the report.

Yes. While the OpenAI Agents SDK discovers all available tools, you can implement custom guardrails or logic within your agent's code to restrict it from using certain Northbeam functions.

Yes, it's designed for that. The SDK's guardrails validate actions before they execute. This prevents your agent from, for example, accidentally triggering a massive, incorrect data export from Northbeam.

Your agent can call the `get_export_status` tool with the export ID. The OpenAI dashboard provides a full trace of these interactions, so you can see the agent's entire monitoring process.

The server only handles Northbeam attribution data, like campaign IDs, spend, and revenue metrics. Your Vinkius endpoint is sandboxed and ephemeral. All communication is encrypted, and access is controlled by a single token you manage.

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