Circleci with OpenAI Agents SDK

How to integrate Circleci MCP with OpenAI Agents SDK

Trusted by

GET STARTED FOR FREE GET A DEMO

30 min · no commitment · see it on your stack

Introduction Also integrate Circleci with TL;DR What is OpenAI Agents SDK What is the Circleci MCP server Supported Tools & Triggers Creating MCP Server - Stand-alone vs Composio SDK Step-by-step Guide Complete Code Conclusion How to build Circleci MCP Agent with another framework Explore Other Toolkits FAQ

Connect Circleci without Auth hassles

We manage OAuth, API Key, token refresh, and scopes, you just build.

Try for Free

Introduction

This guide walks you through connecting Circleci to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Circleci agent that can trigger a new pipeline on main branch, list all pipelines for backend service, get test results from last successful build through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Circleci account through Composio's Circleci MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Circleci with

Claude Agent SDK Claude Code Claude Cowork Codex OpenClaw Hermes CLI Google ADK LangChain Vercel AI SDK Mastra AI LlamaIndex CrewAI

TL;DR

Here's what you'll learn:

Get and set up your OpenAI and Composio API keys
Install the necessary dependencies
Initialize Composio and create a Tool Router session for Circleci
Configure an AI agent that can use Circleci as a tool
Run a live chat session where you can ask the agent to perform Circleci operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

Hosted MCP Tools: Connect to external services through hosted MCP endpoints
SQLite Sessions: Persist conversation history across interactions
Simple API: Clean interface with Agent, Runner, and tool configuration
Streaming Support: Real-time response streaming for interactive applications

What is the Circleci MCP server, and what's possible with it?

The Circleci MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Circleci account. It provides structured and secure access to your Circleci projects and pipelines, so your agent can trigger builds, fetch job artifacts, monitor workflows, and analyze test results on your behalf.

Automated pipeline triggering and management: Let your agent start new builds for specific branches or tags, enabling continuous integration workflows without manual intervention.
Workflow and job status monitoring: Ask your agent to fetch detailed information about jobs and workflows, including status, timing, and execution environment, to stay on top of your CI/CD processes.
Artifact and test result retrieval: Have the agent collect job artifacts or extract comprehensive test metadata and failure messages for easier debugging and reporting.
Pipeline and runner insights: Get your agent to list all pipelines for a project or enumerate available self-hosted runners, making it simple to manage and audit your Circleci resources.
User and configuration access: Retrieve user profile details or fetch pipeline YAML configurations as needed for documentation, troubleshooting, or workflow optimization.

Supported Tools & Triggers

Tools

Create ContextTool to create a new context in CircleCI.

Create Context (GraphQL)Tool to create a new CircleCI context using the GraphQL API.

Create Context RestrictionTool to create a context restriction in CircleCI.

Create Organization Orb AllowlistTool to create a new URL Orb allow-list entry for an organization.

Create Organization ProjectTool to create a new project within a CircleCI organization.

Create Organization GroupTool to create a group in an organization.

Create Project Environment VariableTool to create a new environment variable for a CircleCI project.

Create Usage Export JobTool to create a usage export job for a CircleCI organization.

Delete Context (GraphQL)Tool to delete a CircleCI context by its UUID using GraphQL API.

Delete Context RestrictionTool to delete a context restriction by its ID.

Delete Namespace and Related OrbsTool to delete a CircleCI registry namespace and all its associated orbs.

Delete Namespace AliasTool to remove a namespace alias by name in CircleCI.

Delete Organization Orb Allowlist EntryTool to remove an entry from the organization's URL orb allow-list.

Delete Organization GroupTool to delete a group from a CircleCI organization.

Delete ProjectTool to delete a CircleCI project and its settings.

Delete Project Environment VariableTool to delete an environment variable from a CircleCI project.

Get ContextTool to retrieve a context by its unique ID.

Get Current UserTool to retrieve information about the currently authenticated user.

Get Flaky TestsTool to get flaky tests for a project.

Get Job ArtifactsRetrieves artifacts (output files like test results, logs, build binaries, reports) produced by a CircleCI job.

Get Job DetailsTool to fetch details of a specific job within a project.

Get Orb DetailsTool to query detailed information about a CircleCI orb using the GraphQL API.

Get Orb VersionTool to retrieve detailed information about a specific CircleCI orb version via GraphQL.

Get OrganizationTool to retrieve organization details from CircleCI using GraphQL query.

Get Organization GroupTool to retrieve a group in an organization.

Get Pipeline ConfigTool to fetch pipeline configuration by ID.

Get Pipeline DefinitionTool to retrieve a pipeline definition by project and definition ID.

Get ProjectTool to retrieve a CircleCI project by its slug.

Get Project WorkflowsTool to get summary metrics for all workflows of a project.

Get Test MetadataTool to fetch test metadata for a specific job.

Get Usage Export JobTool to retrieve a usage export job by organization ID and job ID.

Get User InformationTool to retrieve information about a CircleCI user by their unique ID.

Get Workflow SummaryTool to get metrics and trends for a workflow.

List Context Environment VariablesTool to list all environment variables for a specific context.

List Insights BranchesTool to get all branches for a project from CircleCI Insights.

List Insights SummaryTool to get summary metrics with trends for the entire organization and for each project.

List Namespace OrbsTool to list orbs in a CircleCI registry namespace with pagination support.

List Orb CategoriesTool to retrieve all CircleCI orb categories with pagination support.

List OrbsTool to list CircleCI orbs with pagination support via GraphQL API.

List Organization GroupsTool to list all groups in a CircleCI organization.

List Pages SummaryTool to get summary metrics and trends for a project across its workflows and branches.

List Pipeline DefinitionsTool to list all pipeline definitions for a specific project.

List PipelinesTool to get a list of pipelines for an organization.

List Pipelines for ProjectTool to list all pipelines for a specific project.

List Project Environment VariablesTool to list all environment variables for a CircleCI project.

List Project SchedulesTool to list all schedules for a specific project.

List Self-Hosted RunnersList self-hosted runners in CircleCI.

List User CollaborationsTool to retrieve organizations where the authenticated user has access.

List Workflows by Pipeline IDTool to list all workflows associated with a specific pipeline.

List Workflows Jobs WorkflowsTool to get summary metrics for a project workflow's jobs.

List Workflows Test MetricsTool to get test metrics for a project's workflows.

Query ContextTool to retrieve a CircleCI context by its UUID using GraphQL API.

Query Namespace ExistsTool to determine if a namespace exists in the CircleCI registry.

Query Orb Category IDTool to fetch the unique category ID for a CircleCI orb category by its name.

Query Orb ExistsTool to check if an orb exists in CircleCI registry and retrieve its privacy status.

Query Orb IDTool to fetch an orb's ID and optionally its namespace ID by orb name.

Query Orb Latest VersionTool to fetch the latest published version of a CircleCI orb.

Query Orb SourceTool to retrieve source code of a specific CircleCI orb version via GraphQL.

Query Plan MetricsTool to query plan metrics including credit usage by project and organization for a date range.

Remove Context Environment Variable (GraphQL)Tool to remove an environment variable from a CircleCI context using GraphQL API.

Rename NamespaceTool to rename a CircleCI namespace by its UUID identifier.

Store Environment VariableTool to store an environment variable in a CircleCI context using GraphQL mutation.

Trigger PipelineTriggers a new CI/CD pipeline run for a specified CircleCI project.

Upsert Context Environment VariableTool to add or update an environment variable in a CircleCI context.

Validate Orb ConfigTool to validate CircleCI orb YAML configuration using the orbConfig GraphQL query.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Prerequisites

Before starting, make sure you have:

Composio API Key and OpenAI API Key
Primary know-how of OpenAI Agents SDK
A live Circleci project
Some knowledge of Python or Typescript

Getting API Keys for OpenAI and Composio

OpenAI API Key

Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
Keep the API key safe.

Composio API Key

Log in to the Composio dashboard.
Go to Settings and copy your API key.

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

Set up environment variables

bash

OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

What's happening:

You're importing all necessary libraries.
The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Circleci.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

What's happening:

load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Circleci Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["circleci"]
)

mcp_url = session.mcp.url

What is happening:

You give the Tool Router the user id and the toolkits you want available. Here, it is only circleci.
The router checks the user's Circleci connection and prepares the MCP endpoint.
The returned session.mcp.url is the MCP URL that your agent will use to access Circleci.
This approach keeps things lightweight and lets the agent request Circleci tools only when needed during the conversation.

Configure the agent

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Circleci. "
        "Help users perform Circleci operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

What's happening:

We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
The agent's instructions tell it that it can access Circleci and help with queries, inserts, updates, authentication, and fetching database information.
The tools array includes a HostedMCPTool that connects to the MCP server URL we created earlier.
The headers dict includes the Composio API key for secure authentication with the MCP server.
require_approval: 'never' means the agent can execute Circleci operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

What's happening:

The program prints a session URL that you visit to authorize Circleci.
After authorization, the chat begins.
Each message you type is processed by the agent using Runner.run().
The responses are printed to the console, and conversations are saved locally using SQLite.
Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Circleci and OpenAI Agents SDK:

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["circleci"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Circleci. "
        "Help users perform Circleci operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

Conclusion

This was a starter code for integrating Circleci MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Circleci.

Key features:

Hosted MCP tool integration through Composio's Tool Router
SQLite session persistence for conversation history
Simple async chat loop for interactive testing

You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.

How to build Circleci MCP Agent with another framework

Claude Agent SDK

Use Circleci MCP with Claude Agent SDK

Claude Code

Use Circleci MCP with Claude Code

Claude Cowork

Use Circleci MCP with Claude Cowork

Codex

Use Circleci MCP with Codex

OpenClaw

Use Circleci MCP with OpenClaw

Hermes

Use Circleci MCP with Hermes

CLI

Use Circleci MCP with CLI

Google ADK

Use Circleci MCP with Google ADK

LangChain

Use Circleci MCP with LangChain

Vercel AI SDK

Use Circleci MCP with Vercel AI SDK

Mastra AI

Use Circleci MCP with Mastra AI

LlamaIndex

Use Circleci MCP with LlamaIndex

CrewAI

Use Circleci MCP with CrewAI

Explore Other Toolkits

Supabase

Oauth2Api Key

Supabase is an open-source backend platform offering scalable Postgres databases, authentication, storage, and real-time APIs. It lets developers build modern apps without managing infrastructure.

Codeinterpreter

No Auth

Codeinterpreter is a Python-based coding environment with built-in data analysis and visualization. It lets you instantly run scripts, plot results, and prototype solutions inside supported platforms.

GitHub

Oauth2

GitHub is a code hosting platform for version control and collaborative software development. It streamlines project management, code review, and team workflows in one place.

TOOLKIT MARKETPLACE

FAQ

What are the differences in Tool Router MCP and Circleci MCP?

With a standalone Circleci MCP server, the agents and LLMs can only access a fixed set of Circleci tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Circleci and many other apps based on the task at hand, all through a single MCP endpoint.

Can I use Tool Router MCP with OpenAI Agents SDK?

Yes, you can. OpenAI Agents SDK fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Circleci tools.

Can I manage the permissions and scopes for Circleci while using Tool Router?

Yes, absolutely. You can configure which Circleci scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Circleci data and credentials are handled as safely as possible.

Used by agents from

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Get started for free Get a demo↗

Harsha GaddipatiCo-founder, Slashy

Karan skipped his own birthday party to fix our critical issue. It was 10 pm and he diverted his Waymo to help us instead. This really sets the bar, shows you the commitment you need to have when users rely on your software.

Abhi AryaCo-founder, Opennote

A lot of students tell us that the moment their connected tools start talking to each other inside Opennote feels almost magical. The agent just knows them, and it has immensely helped in keeping new users on the platform.

Nirman DaveCEO, Zams

We chose Composio over Pipedream because it delivered depth where it mattered. It supported niche tools and tricky edge cases that other platforms simply ignored. Giving us confidence to scale without compromising.

Ryan YuFounder, Extra Thursday

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down in the complexities of managing agent auth would have been a death sentence for Extra Thursday.

Tomisin JenrolaFounder & CEO, SwarmZero

Before partnering with Composio, adding tool integrations was a slow, resource-intensive process. Each integration could take weeks or months of engineering time, and maintaining them meant constantly keeping up with API changes.

Jerome LeclancheCo-Founder, Ingram Technologies

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

How to integrate Circleci MCP with OpenAI Agents SDK

Table of Contents

Connect Circleci without Auth hassles

Introduction

Also integrate Circleci with

TL;DR

What is OpenAI Agents SDK?

What is the Circleci MCP server, and what's possible with it?

Supported Tools & Triggers

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

How the Composio SDK works

Step-by-step Guide

Prerequisites

Getting API Keys for OpenAI and Composio

Install dependencies

Set up environment variables

Import dependencies

Set up the Composio instance

Create a Tool Router session

Configure the agent

Start chat loop and handle conversation

Complete Code

Conclusion

How to build Circleci MCP Agent with another framework

Claude Agent SDK

Claude Code

Claude Cowork

Codex

OpenClaw

Hermes

CLI

Google ADK

LangChain

Vercel AI SDK

Mastra AI

LlamaIndex

CrewAI

Explore Other Toolkits

Supabase

Codeinterpreter

GitHub

FAQ

What are the differences in Tool Router MCP and Circleci MCP?

Can I use Tool Router MCP with OpenAI Agents SDK?

Can I manage the permissions and scopes for Circleci while using Tool Router?

How safe is my data with Composio Tool Router?

Used by agents from

Never worry about agent reliability