How to integrate Circleci MCP with Mastra AI

Trusted by
AWS
Glean
Zoom
Airtable
GET STARTED FOR FREEGET A DEMO

30 min · no commitment · see it on your stack

Circleci logo
Mastra AI logo
divider

Introduction

This guide walks you through connecting Circleci to Mastra AI 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 Mastra AI 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

TL;DR

Here's what you'll learn:
  • Set up your environment so Mastra, OpenAI, and Composio work together
  • Create a Tool Router session in Composio that exposes Circleci tools
  • Connect Mastra's MCP client to the Composio generated MCP URL
  • Fetch Circleci tool definitions and attach them as a toolset
  • Build a Mastra agent that can reason, call tools, and return structured results
  • Run an interactive CLI where you can chat with your Circleci agent

What is Mastra AI?

Mastra AI is a TypeScript framework for building AI agents with tool support. It provides a clean API for creating agents that can use external services through MCP.

Key features include:

  • MCP Client: Built-in support for Model Context Protocol servers
  • Toolsets: Organize tools into logical groups
  • Step Callbacks: Monitor and debug agent execution
  • OpenAI Integration: Works with OpenAI models via @ai-sdk/openai

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:

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

Step-by-step Guide

Prerequisites

Before starting, make sure you have:
  • Node.js 18 or higher
  • A Composio account with an active API key
  • An OpenAI API key
  • Basic familiarity with TypeScript

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key.
  • You need credits or a connected billing setup to use the models.
  • Store the key somewhere safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Go to Settings and copy your API key.
  • This key lets your Mastra agent talk to Composio and reach Circleci through MCP.

Install dependencies

bash
npm install @composio/core @mastra/core @mastra/mcp @ai-sdk/openai dotenv

Install the required packages.

What's happening:

  • @composio/core is the Composio SDK for creating MCP sessions
  • @mastra/core provides the Agent class
  • @mastra/mcp is Mastra's MCP client
  • @ai-sdk/openai is the model wrapper for OpenAI
  • dotenv loads environment variables from .env

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key_here

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates your requests to Composio
  • COMPOSIO_USER_ID tells Composio which user this session belongs to
  • OPENAI_API_KEY lets the Mastra agent call OpenAI models

Import libraries and validate environment

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey as string,
});
What's happening:
  • dotenv/config auto loads your .env so process.env.* is available
  • openai gives you a Mastra compatible model wrapper
  • Agent is the Mastra agent that will call tools and produce answers
  • MCPClient connects Mastra to your Composio MCP server
  • Composio is used to create a Tool Router session

Create a Tool Router session for Circleci

typescript
async function main() {
  const session = await composio.create(
    composioUserID as string,
    {
      toolkits: ["circleci"],
    },
  );

  const composioMCPUrl = session.mcp.url;
  console.log("Circleci MCP URL:", composioMCPUrl);
What's happening:
  • create spins up a short-lived MCP HTTP endpoint for this user
  • The toolkits array contains "circleci" for Circleci access
  • session.mcp.url is the MCP URL that Mastra's MCPClient will connect to

Configure Mastra MCP client and fetch tools

typescript
const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      nasdaq: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

console.log("Fetching MCP tools from Composio...");
const composioTools = await mcpClient.getTools();
console.log("Number of tools:", Object.keys(composioTools).length);
What's happening:
  • MCPClient takes an id for this client and a list of MCP servers
  • The headers property includes the x-api-key for authentication
  • getTools fetches the tool definitions exposed by the Circleci toolkit

Create the Mastra agent

typescript
const agent = new Agent({
    name: "circleci-mastra-agent",
    instructions: "You are an AI agent with Circleci tools via Composio.",
    model: "openai/gpt-5",
  });
What's happening:
  • Agent is the core Mastra agent
  • name is just an identifier for logging and debugging
  • instructions guide the agent to use tools instead of only answering in natural language
  • model uses openai("gpt-5") to configure the underlying LLM

Set up interactive chat interface

typescript
let messages: AiMessageType[] = [];

console.log("Chat started! Type 'exit' or 'quit' to end.\n");

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: "> ",
});

rl.prompt();

rl.on("line", async (userInput: string) => {
  const trimmedInput = userInput.trim();

  if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
    console.log("\nGoodbye!");
    rl.close();
    process.exit(0);
  }

  if (!trimmedInput) {
    rl.prompt();
    return;
  }

  messages.push({
    id: crypto.randomUUID(),
    role: "user",
    content: trimmedInput,
  });

  console.log("\nAgent is thinking...\n");

  try {
    const response = await agent.generate(messages, {
      toolsets: {
        circleci: composioTools,
      },
      maxSteps: 8,
    });

    const { text } = response;

    if (text && text.trim().length > 0) {
      console.log(`Agent: ${text}\n`);
        messages.push({
          id: crypto.randomUUID(),
          role: "assistant",
          content: text,
        });
      }
    } catch (error) {
      console.error("\nError:", error);
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    console.log("\nSession ended.");
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});
What's happening:
  • messages keeps the full conversation history in Mastra's expected format
  • agent.generate runs the agent with conversation history and Circleci toolsets
  • maxSteps limits how many tool calls the agent can take in a single run
  • onStepFinish is a hook that prints intermediate steps for debugging

Complete Code

Here's the complete code to get you started with Circleci and Mastra AI:

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({ apiKey: composioAPIKey as string });

async function main() {
  const session = await composio.create(composioUserID as string, {
    toolkits: ["circleci"],
  });

  const composioMCPUrl = session.mcp.url;

  const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      circleci: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

  const composioTools = await mcpClient.getTools();

  const agent = new Agent({
    name: "circleci-mastra-agent",
    instructions: "You are an AI agent with Circleci tools via Composio.",
    model: "openai/gpt-5",
  });

  let messages: AiMessageType[] = [];

  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: "> ",
  });

  rl.prompt();

  rl.on("line", async (input: string) => {
    const trimmed = input.trim();
    if (["exit", "quit"].includes(trimmed.toLowerCase())) {
      rl.close();
      return;
    }

    messages.push({ id: crypto.randomUUID(), role: "user", content: trimmed });

    const { text } = await agent.generate(messages, {
      toolsets: { circleci: composioTools },
      maxSteps: 8,
    });

    if (text) {
      console.log(`Agent: ${text}\n`);
      messages.push({ id: crypto.randomUUID(), role: "assistant", content: text });
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main();

Conclusion

You've built a Mastra AI agent that can interact with Circleci through Composio's Tool Router. You can extend this further by:
  • Adding other toolkits like Gmail, Slack, or GitHub
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows

How to build Circleci MCP Agent with another framework

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Circleci MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use Circleci MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Circleci MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Circleci MCP with Claude Cowork

Codex logo

Codex

Use Circleci MCP with Codex

OpenClaw logo

OpenClaw

Use Circleci MCP with OpenClaw

Hermes logo

Hermes

Use Circleci MCP with Hermes

CLI logo

CLI

Use Circleci MCP with CLI

Google ADK logo

Google ADK

Use Circleci MCP with Google ADK

LangChain logo

LangChain

Use Circleci MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Circleci MCP with Vercel AI SDK

LlamaIndex logo

LlamaIndex

Use Circleci MCP with LlamaIndex

CrewAI logo

CrewAI

Use Circleci MCP with CrewAI

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 Mastra AI?

Yes, you can. Mastra AI 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

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

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 freeGet a demo↗