How to integrate DeployHQ MCP with Mastra AI

This guide walks you through connecting DeployHQ to Mastra AI using the Composio tool router. By the end, you'll have a working DeployHQ agent that can trigger a deployment for project x, list all deployments for project y, get status of last deployment through natural language commands. This guide will help you understand how to give your Mastra AI agent real control over a DeployHQ account through Composio's DeployHQ MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Get started for freeGet a demo
DeployHQ logoDeployHQ
Basic

DeployHQ is a deployment automation service for Git, SVN, and Mercurial projects. It streamlines code deployments, making project launches seamless and reliable.

61 Tools

Introduction

This guide walks you through connecting DeployHQ to Mastra AI using the Composio tool router. By the end, you'll have a working DeployHQ agent that can trigger a deployment for project x, list all deployments for project y, get status of last deployment through natural language commands.

This guide will help you understand how to give your Mastra AI agent real control over a DeployHQ account through Composio's DeployHQ MCP server.

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

Also integrate DeployHQ with

OpenAI Agents SDKClaude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKLlamaIndexCrewAI

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 DeployHQ tools
  • Connect Mastra's MCP client to the Composio generated MCP URL
  • Fetch DeployHQ 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 DeployHQ 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 DeployHQ MCP server, and what's possible with it?

The DeployHQ MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your DeployHQ account. It provides structured and secure access so your agent can perform DeployHQ operations on your behalf.

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

Step by step09 STEPS
1

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
2

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 DeployHQ through MCP.
3

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
4

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
5

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
6

Create a Tool Router session for DeployHQ

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

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

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 DeployHQ toolkit
8

Create the Mastra agent

typescript
const agent = new Agent({
    name: "deployhq-mastra-agent",
    instructions: "You are an AI agent with DeployHQ 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
9

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: {
        deployhq: 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 DeployHQ 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 DeployHQ 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: ["deployhq"],
  });

  const composioMCPUrl = session.mcp.url;

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

  const composioTools = await mcpClient.getTools();

  const agent = new Agent({
    name: "deployhq-mastra-agent",
    instructions: "You are an AI agent with DeployHQ 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: { deployhq: 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 DeployHQ 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
TOOLS

Supported Tools

Every DeployHQ action and event your agent gets out of the box.

Delete Command

Tool to delete a command from a specified project.

Delete Project

Tool to delete a project from DeployHQ.

Delete Build Cache File

Tool to delete an existing build cache file from a project.

Delete Excluded File Rule

Tool to delete an existing excluded file rule from a project.

Delete Server Group

Tool to delete a server group from a project using the DeployHQ API.

Delete Template

Tool to delete a template by its unique permalink.

Get Projects

Tool to retrieve all projects from DeployHQ account.

Get Project

Tool to view an existing project in DeployHQ.

Get Project Build Known Hosts

Tool to list all known hosts within a project using DeployHQ API.

Get Project Commands

Tool to retrieve all SSH commands configured for a project.

Get Project Config Files

Tool to retrieve a list of all config files in a DeployHQ project.

Get Project Deployments

Tool to retrieve a paginated list of all deployments in a project.

Get Project Excluded Files

Tool to list all excluded files within a project template.

Get Config File

Tool to view a specific config file in a DeployHQ project.

Get Excluded File

Tool to view a specific excluded file in a DeployHQ project.

Get Server Group

Tool to view a specific server group in a DeployHQ project.

Get Project Repository

Tool to view repository details for a specific project in DeployHQ.

Get Repository Branches

Tool to view all available branches in the connected repository for a project.

Get Repository Commit Info

Tool to view detailed information about a specific revision in a project's connected repository.

Get Latest Repository Revision

Tool to view the latest remote revision of your repository.

Get Recent Commits and Tags

Tool to view up to 15 most recent revisions and up to 15 most recent tags in a specific branch.

Get Project Scheduled Deployments

Tool to retrieve all upcoming scheduled deployments for a project.

Get Project Server Groups

Tool to retrieve all server groups configured for a project.

Get Project Servers

Tool to retrieve all servers configured for a project.

Get Templates

Tool to retrieve all templates from DeployHQ account.

Get Public Template

Tool to retrieve a specific public template from DeployHQ.

Get Public Templates

Tool to retrieve publicly available deployment templates from DeployHQ.

Update Project

Tool to update project settings in DeployHQ.

Update Build Cache File

Tool to update an existing build cache file in a project.

Update Build Command

Tool to update an existing build command in a project.

Update Language Version

Tool to update the version of a language in a project's build environment.

Update Project Command

Tool to update an existing SSH command in a project.

Update Config File

Tool to update an existing config file in a DeployHQ project.

Update Excluded File

Tool to update an existing excluded file rule in a project.

Update Project Repository

Tool to update repository configuration for a project in DeployHQ.

Update Server Group

Tool to update an existing server group in a DeployHQ project.

Update Template

Tool to update an existing template in DeployHQ.

Create Project

Tool to create a new project in DeployHQ.

Generate AI Deployment Overview

Tool to generate an AI-powered deployment overview for a revision range.

Create Build Cache File

Tool to create a new build cached file within a project.

Create Build Command

Tool to create a new build command for a project in DeployHQ.

Create Project Build Known Host

Tool to create a new known host in a project using DeployHQ API.

Create SSH Command

Tool to create a new SSH command for a project in DeployHQ.

Create Config File

Tool to create a new config file in a DeployHQ project.

Create Config File Deployment

Tool to create a new config file deployment for a project.

Create Excluded File

Tool to add a new excluded file to a project.

Abort Deployment

Tool to abort a currently running deployment.

Add Project Repository

Tool to add repository details to a project in DeployHQ.

Create Server Group

Tool to create a new server group for automated deployments in a DeployHQ project.

Create Server

Tool to create a new server configuration in a DeployHQ project.

Create Template

Tool to create a new template in DeployHQ.

Update Project Settings

Tool to update settings of an existing DeployHQ project.

Edit Build Cache File

Tool to edit an existing build cache file within a project.

Edit Build Command

Tool to edit an existing build command within a template in DeployHQ.

Edit SSH Command

Tool to edit an existing SSH command in a DeployHQ project.

Edit Config File

Tool to edit an existing config file within a project.

Edit Excluded File

Tool to edit an existing excluded file rule within a project.

Update Excluded File

Tool to update an existing excluded file rule in a project.

Update Project Repository

Tool to update repository details for an existing project in DeployHQ.

Update Server Group

Tool to update a server group in a DeployHQ project using the API.

Edit Template

Tool to edit an existing template in DeployHQ.

FRAMEWORKS

How to build DeployHQ MCP Agent with another framework

OpenAI Agents SDK logo

OpenAI Agents SDK

Use DeployHQ MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use DeployHQ MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use DeployHQ MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use DeployHQ MCP with Claude Cowork

Codex logo

Codex

Use DeployHQ MCP with Codex

OpenClaw logo

OpenClaw

Use DeployHQ MCP with OpenClaw

Hermes logo

Hermes

Use DeployHQ MCP with Hermes

CLI logo

CLI

Use DeployHQ MCP with CLI

Google ADK logo

Google ADK

Use DeployHQ MCP with Google ADK

LangChain logo

LangChain

Use DeployHQ MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use DeployHQ MCP with Vercel AI SDK

LlamaIndex logo

LlamaIndex

Use DeployHQ MCP with LlamaIndex

CrewAI logo

CrewAI

Use DeployHQ MCP with CrewAI

FAQ

Frequently asked questions

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

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 DeployHQ tools.

Yes, absolutely. You can configure which DeployHQ 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.

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 DeployHQ data and credentials are handled as safely as possible.

Start with DeployHQ.It takes 30 seconds.

Managed auth, hosted MCP servers, and every DeployHQ tool your agent needs.Free to start.

Start building
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

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

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

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's immensely helped keep new users on the platform.

Abhi Arya
Abhi Arya
Co-founder, Opennote

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

Nirman Dave
Nirman Dave
CEO, Zams

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

Ryan Yu
Ryan Yu
Founder, Extra Thursday

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

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

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.

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies