How to integrate DeployHQ MCP with LlamaIndex

This guide walks you through connecting DeployHQ to LlamaIndex 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 LlamaIndex 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.

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

TL;DR

Here's what you'll learn:
  • Set your OpenAI and Composio API keys
  • Install LlamaIndex and Composio packages
  • Create a Composio Tool Router session for DeployHQ
  • Connect LlamaIndex to the DeployHQ MCP server
  • Build a DeployHQ-powered agent using LlamaIndex
  • Interact with DeployHQ through natural language

What is LlamaIndex?

LlamaIndex is a data framework for building LLM applications. It provides tools for connecting LLMs to external data sources and services through agents and tools.

Key features include:

  • ReAct Agent: Reasoning and acting pattern for tool-using agents
  • MCP Tools: Native support for Model Context Protocol
  • Context Management: Maintain conversation context across interactions
  • Async Support: Built for async/await patterns

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 step10 STEPS
1

Prerequisites

Before you begin, make sure you have:
  • Python 3.8/Node 16 or higher installed
  • A Composio account with the API key
  • An OpenAI API key
  • A DeployHQ account and project
  • Basic familiarity with async Python/Typescript
2

Getting API Keys for OpenAI, Composio, and DeployHQ

OpenAI API key (OPENAI_API_KEY)
  • Go to the OpenAI dashboard
  • Create an API key if you don't have one
  • Assign it to OPENAI_API_KEY in .env
Composio API key and user ID
  • Log into the Composio dashboard
  • Copy your API key from Settings
    • Use this as COMPOSIO_API_KEY
  • Pick a stable user identifier (email or ID)
    • Use this as COMPOSIO_USER_ID
3

Installing dependencies

npm install @composio/llamaindex @llamaindex/openai @llamaindex/tools @llamaindex/workflow dotenv

Create a new Typescript project and install the necessary dependencies:

  • @composio/llamaindex: Composio's LlamaIndex integration
  • @llamaindex/openai: OpenAI LLM integration
  • @llamaindex/tools: MCP client for LlamaIndex
  • @llamaindex/workflow: Workflow framework for LlamaIndex
  • dotenv: Environment variable management
4

Set environment variables

bash
OPENAI_API_KEY=your-openai-api-key
COMPOSIO_API_KEY=your-composio-api-key
COMPOSIO_USER_ID=your-user-id

Create a .env file in your project root:

These credentials will be used to:

  • Authenticate with OpenAI's GPT-5 model
  • Connect to Composio's Tool Router
  • Identify your Composio user session for DeployHQ access
5

Import modules

import "dotenv/config";
import readline from "node:readline/promises";
import { stdin as input, stdout as output } from "node:process";

import { Composio } from "@composio/core";

import { mcp } from "@llamaindex/tools";
import { agent as createAgent } from "@llamaindex/workflow";
import { openai } from "@llamaindex/openai";

dotenv.config();

Create a new file called deployhq_llamaindex_agent.ts and import the required modules:

Key imports:

  • dotenv.config loads .env at runtime
  • readline gives us a simple CLI chat loop
  • Composio is the main Composio SDK client
  • mcp connects to an MCP endpoint
  • createAgent builds a LlamaIndex agent
  • openai configures the LLM backend
6

Load environment variables and initialize Composio

const OPENAI_API_KEY = process.env.OPENAI_API_KEY;
const COMPOSIO_API_KEY = process.env.COMPOSIO_API_KEY;
const COMPOSIO_USER_ID = process.env.COMPOSIO_USER_ID;

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

What's happening:

This ensures missing credentials cause early, clear errors before the agent attempts to initialise.

7

Create a Tool Router session and build the agent function

async function buildAgent() {

  console.log(`Initializing Composio client...${COMPOSIO_USER_ID!}...`);
  console.log(`COMPOSIO_USER_ID: ${COMPOSIO_USER_ID!}...`);

  const composio = new Composio({
    apiKey: COMPOSIO_API_KEY,
    provider: new LlamaindexProvider(),
  });

  const session = await composio.create(
    COMPOSIO_USER_ID!,
    {
      toolkits: ["deployhq"],
    },
  );

  const mcpUrl = session.mcp.url;
  console.log(`Composio Tool Router MCP URL: ${mcpUrl}`);

  const server = mcp({
    url: mcpUrl,
    clientName: "composio_tool_router_with_llamaindex",
    requestInit: {
      headers: {
        "x-api-key": COMPOSIO_API_KEY!,
      },
    },
    // verbose: true,
  });

  const tools = await server.tools();

  const llm = openai({ apiKey: OPENAI_API_KEY, model: "gpt-5" });

  const agent = createAgent({
    name: "composio_tool_router_with_llamaindex",
        description : "An agent that uses Composio Tool Router MCP tools to perform actions.",
    systemPrompt:
      "You are a helpful assistant connected to Composio Tool Router."+
"Use the available tools to answer user queries and perform DeployHQ actions." ,
    llm,
    tools,
  });

  return agent;
}

What's happening here:

  • We create a Composio client using your API key and configure it with the LlamaIndex provider
  • We then create a tool router MCP session for your user, specifying the toolkits we want to use (in this case, deployhq)
  • The session returns an MCP HTTP endpoint URL that acts as a gateway to all your configured tools
  • LlamaIndex will connect to this endpoint to dynamically discover and use the available DeployHQ tools.
  • The MCP tools are mapped to LlamaIndex-compatible tools and plug them into the Agent.
8

Create an interactive chat loop

async function chatLoop(agent: ReturnType<typeof createAgent>) {
  const rl = readline.createInterface({ input, output });

  console.log("Type 'quit' or 'exit' to stop.");

  while (true) {
    let userInput: string;

    try {
      userInput = (await rl.question("\nYou: ")).trim();
    } catch {
      console.log("\nAgent: Bye!");
      break;
    }

    if (!userInput) {
      continue;
    }

    const lower = userInput.toLowerCase();
    if (lower === "quit" || lower === "exit") {
      console.log("Agent: Bye!");
      break;
    }

    try {
      process.stdout.write("Agent: ");

      const stream = agent.runStream(userInput);
      let finalResult: any = null;

      for await (const event of stream) {
        // The event.data contains the streamed content
        const data: any = event.data;

        // Check for streaming delta content
        if (data?.delta) {
          process.stdout.write(data.delta);
        }

        // Store final result for fallback
        if (data?.result || data?.message) {
          finalResult = data;
        }
      }

      // If no streaming happened, show the final result
      if (finalResult) {
        const answer =
          finalResult.result ??
          finalResult.message?.content ??
          finalResult.message ??
          "";
        if (answer && typeof answer === "string" && !answer.includes("[object")) {
          process.stdout.write(answer);
        }
      }

      console.log(); // New line after streaming completes
    } catch (err: any) {
      console.error("\nAgent error:", err?.message ?? err);
    }
  }

  rl.close();
}

What's happening:

  • We're creating a direct terminal interface to chat with DeployHQ
  • The LLM's responses are streamed to the CLI for faster interaction.
  • The agent uses context to maintain conversation history
  • The agent processes the request, selects appropriate DeployHQ tools, and returns a result
  • We extract the answer from the result data structure and display it to the user
  • You can type 'quit' or 'exit' to stop the chat loop gracefully
  • Agent responses and any errors are streamed in a clear, readable format
9

Define the main entry point

async function main() {
  try {
    const agent = await buildAgent();
    await chatLoop(agent);
  } catch (err) {
    console.error("Failed to start agent:", err);
    process.exit(1);
  }
}

main();

What's happening here:

  • We're orchestrating the entire application flow
  • The agent gets built with proper error handling
  • Then we kick off the interactive chat loop so you can start talking to DeployHQ
10

Run the agent

npx ts-node llamaindex-agent.ts

When prompted, authenticate and authorise your agent with DeployHQ, then start asking questions.

Complete Code

Here's the complete code to get you started with DeployHQ and LlamaIndex:

import "dotenv/config";
import readline from "node:readline/promises";
import { stdin as input, stdout as output } from "node:process";

import { Composio } from "@composio/core";
import { LlamaindexProvider } from "@composio/llamaindex";

import { mcp } from "@llamaindex/tools";
import { agent as createAgent } from "@llamaindex/workflow";
import { openai } from "@llamaindex/openai";

dotenv.config();

const OPENAI_API_KEY = process.env.OPENAI_API_KEY;
const COMPOSIO_API_KEY = process.env.COMPOSIO_API_KEY;
const COMPOSIO_USER_ID = process.env.COMPOSIO_USER_ID;

if (!OPENAI_API_KEY) {
    throw new Error("OPENAI_API_KEY is not set in the environment");
  }
if (!COMPOSIO_API_KEY) {
    throw new Error("COMPOSIO_API_KEY is not set in the environment");
  }
if (!COMPOSIO_USER_ID) {
    throw new Error("COMPOSIO_USER_ID is not set in the environment");
  }

async function buildAgent() {

  console.log(`Initializing Composio client...${COMPOSIO_USER_ID!}...`);
  console.log(`COMPOSIO_USER_ID: ${COMPOSIO_USER_ID!}...`);

  const composio = new Composio({
    apiKey: COMPOSIO_API_KEY,
    provider: new LlamaindexProvider(),
  });

  const session = await composio.create(
    COMPOSIO_USER_ID!,
    {
      toolkits: ["deployhq"],
    },
  );

  const mcpUrl = session.mcp.url;
  console.log(`Composio Tool Router MCP URL: ${mcpUrl}`);

  const server = mcp({
    url: mcpUrl,
    clientName: "composio_tool_router_with_llamaindex",
    requestInit: {
      headers: {
        "x-api-key": COMPOSIO_API_KEY!,
      },
    },
    // verbose: true,
  });

  const tools = await server.tools();

  const llm = openai({ apiKey: OPENAI_API_KEY, model: "gpt-5" });

  const agent = createAgent({
    name: "composio_tool_router_with_llamaindex",
    description:
      "An agent that uses Composio Tool Router MCP tools to perform actions.",
    systemPrompt:
      "You are a helpful assistant connected to Composio Tool Router."+
"Use the available tools to answer user queries and perform DeployHQ actions." ,
    llm,
    tools,
  });

  return agent;
}

async function chatLoop(agent: ReturnType<typeof createAgent>) {
  const rl = readline.createInterface({ input, output });

  console.log("Type 'quit' or 'exit' to stop.");

  while (true) {
    let userInput: string;

    try {
      userInput = (await rl.question("\nYou: ")).trim();
    } catch {
      console.log("\nAgent: Bye!");
      break;
    }

    if (!userInput) {
      continue;
    }

    const lower = userInput.toLowerCase();
    if (lower === "quit" || lower === "exit") {
      console.log("Agent: Bye!");
      break;
    }

    try {
      process.stdout.write("Agent: ");

      const stream = agent.runStream(userInput);
      let finalResult: any = null;

      for await (const event of stream) {
        // The event.data contains the streamed content
        const data: any = event.data;

        // Check for streaming delta content
        if (data?.delta) {
          process.stdout.write(data.delta);
        }

        // Store final result for fallback
        if (data?.result || data?.message) {
          finalResult = data;
        }
      }

      // If no streaming happened, show the final result
      if (finalResult) {
        const answer =
          finalResult.result ??
          finalResult.message?.content ??
          finalResult.message ??
          "";
        if (answer && typeof answer === "string" && !answer.includes("[object")) {
          process.stdout.write(answer);
        }
      }

      console.log(); // New line after streaming completes
    } catch (err: any) {
      console.error("\nAgent error:", err?.message ?? err);
    }
  }

  rl.close();
}

async function main() {
  try {
    const agent = await buildAgent();
    await chatLoop(agent);
  } catch (err: any) {
    console.error("Failed to start agent:", err?.message ?? err);
    process.exit(1);
  }
}

main();

Conclusion

You've successfully connected DeployHQ to LlamaIndex through Composio's Tool Router MCP layer. Key takeaways:
  • Tool Router dynamically exposes DeployHQ tools through an MCP endpoint
  • LlamaIndex's ReActAgent handles reasoning and orchestration; Composio handles integrations
  • The agent becomes more capable without increasing prompt size
  • Async Python provides clean, efficient execution of agent workflows
You can easily extend this to other toolkits like Gmail, Notion, Stripe, GitHub, and more by adding them to the toolkits parameter.
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.

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