How to Use the Umbraco MCP in OpenAI Agents SDK

Q: How do I manage Umbraco content changes using OpenAI Agents SDK?

You use the agent to call tools like updatecmsdocument or createcmsdocument. The guardrails in the OpenAI Agents SDK validate these actions before they hit Umbraco, so you don't accidentally break anything.

Q: Can I list all available schemas with Umbraco using OpenAI Agents SDK?

Yep, calling listdocumenttypes shows you every defined schema in Umbraco. This is key for knowing what structured data your agent can write or read.

Q: If I delete a document from Umbraco using OpenAI Agents SDK, how do I recover it?

Be careful with deletecmsdocument; the tool description says this action is irreversible. If you need to test deletion, use a staging environment first.

Build Production Umbraco 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 Umbraco MCP to OpenAI Agents SDK

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

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Manage Content via MCP Server

The agent can create brand new pages and documents using `create_cms_document`. You just feed it the JSON structure, and it handles the rest of the Umbraco CMS write-up. This means you don't have to manually jump back into the backoffice.

Search & Filter Umbraco Content

Need a specific article or asset? Use `get_delivery_content_by_path` if you know the URL, or use `query_delivery_content` to filter results by content type. This is perfect for building complex data pipelines that need structured input. Listing available items is simple too; `list_delivery_content` gives you paginated access so your agent doesn't hit limits when scraping hundreds of records.

Update & Read Umbraco Assets

Updating content isn't a one-and-done deal. You can adjust existing fields using `update_cms_document`. It keeps your agent in control, ensuring changes are precise. Plus, you get full visibility into the site structure by calling `list_document_types` or getting media files with `list_media_assets`. Everything is accessible right through this MCP Server.

Setup guide

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

Create your Agent

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

Run the agent

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

You use the agent to call tools like `update_cms_document` or `create_cms_document`. The guardrails in the OpenAI Agents SDK validate these actions before they hit Umbraco, so you don't accidentally break anything.

The server primarily touches document JSON fields and media asset metadata. This includes structured data like titles, body text, slugs, and file pointers from the Umbraco CMS.

Yep, calling `list_document_types` shows you every defined schema in Umbraco. This is key for knowing what structured data your agent can write or read.

Be careful with `delete_cms_document`; the tool description says this action is irreversible. If you need to test deletion, use a staging environment first.

The agent will report the validation error directly through its tracing dashboard. Because it's built for production, it won't fail silently; you’ll know exactly why the `query_delivery_content` call failed.

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