How to integrate DeployHQ MCP with OpenAI Agents SDK

This guide walks you through connecting DeployHQ to the OpenAI Agents SDK 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 OpenAI Agents SDK 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 the OpenAI Agents SDK 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 OpenAI Agents SDK 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

Claude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

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 DeployHQ
  • Configure an AI agent that can use DeployHQ as a tool
  • Run a live chat session where you can ask the agent to perform DeployHQ 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 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:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live DeployHQ project
  • Some knowledge of Python or Typescript
2

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
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

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.

5

Import dependencies

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
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 DeployHQ.
6

Set up the Composio instance

dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
What's happening:
  • dotenv.config() loads your .env file so COMPOSIO_API_KEY and USER_ID are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.
7

Create a Tool Router session

// Create Tool Router session for DeployHQ
const session = await composio.create(userId as string, {
  toolkits: ['deployhq'],
});
const mcpUrl = session.mcp.url;

What is happening:

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

Configure the agent

// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access DeployHQ. Help users perform DeployHQ operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: '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 DeployHQ 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 object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute DeployHQ operations without asking for permission each time, making interactions smoother.
9

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

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

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
What's happening:
  • The program prints a session URL that you visit to authorize DeployHQ.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using run().
  • The responses are printed to the console.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

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

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['deployhq'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access DeployHQ. Help users perform DeployHQ operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

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

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});

Conclusion

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

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

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

Mastra AI logo

Mastra AI

Use DeployHQ MCP with Mastra AI

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