# How to integrate DeployHQ MCP with LlamaIndex

```json
{
  "title": "How to integrate DeployHQ MCP with LlamaIndex",
  "toolkit": "DeployHQ",
  "toolkit_slug": "deployhq",
  "framework": "LlamaIndex",
  "framework_slug": "llama-index",
  "url": "https://composio.dev/toolkits/deployhq/framework/llama-index",
  "markdown_url": "https://composio.dev/toolkits/deployhq/framework/llama-index.md",
  "updated_at": "2026-03-29T06:30:06.320Z"
}
```

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

- [OpenAI Agents SDK](https://composio.dev/toolkits/deployhq/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/deployhq/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/deployhq/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/deployhq/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/deployhq/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/deployhq/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/deployhq/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/deployhq/framework/cli)
- [Google ADK](https://composio.dev/toolkits/deployhq/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/deployhq/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/deployhq/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/deployhq/framework/mastra-ai)
- [CrewAI](https://composio.dev/toolkits/deployhq/framework/crew-ai)

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

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `DEPLOYHQ_DELETE_COMMAND` | Delete Command | Tool to delete a command from a specified project. Use when you need to remove an SSH command from a project's configuration. |
| `DEPLOYHQ_DELETE_PROJECTS_PROJECT` | Delete Project | Tool to delete a project from DeployHQ. Use when you need to permanently remove a project by its permalink or identifier. |
| `DEPLOYHQ_DELETE_PROJECTS_PROJECT_BUILD_CACHE_FILES_IDENTIFIER` | Delete Build Cache File | Tool to delete an existing build cache file from a project. Use when you need to remove a cached build artifact from the project's build cache storage. |
| `DEPLOYHQ_DELETE_PROJECTS_PROJECT_EXCLUDED_FILES_IDENTIFIER` | Delete Excluded File Rule | Tool to delete an existing excluded file rule from a project. Use when you need to remove an excluded file pattern from deployment configuration. |
| `DEPLOYHQ_DELETE_SERVER_GROUP` | Delete Server Group | Tool to delete a server group from a project using the DeployHQ API. Use when you need to remove a server group from deployment configuration. |
| `DEPLOYHQ_DELETE_TEMPLATE` | Delete Template | Tool to delete a template by its unique permalink. Use when you need to permanently remove a template from DeployHQ. |
| `DEPLOYHQ_GET_PROJECTS` | Get Projects | Tool to retrieve all projects from DeployHQ account. Use when you need to list all available projects and their configurations. |
| `DEPLOYHQ_GET_PROJECT` | Get Project | Tool to view an existing project in DeployHQ. Use when you need to retrieve details about a specific project by its permalink or identifier. |
| `DEPLOYHQ_GET_PROJECT_BUILD_KNOWN_HOSTS` | Get Project Build Known Hosts | Tool to list all known hosts within a project using DeployHQ API. Use when you need to view SSH known hosts configured for a specific project. |
| `DEPLOYHQ_GET_PROJECT_COMMANDS` | Get Project Commands | Tool to retrieve all SSH commands configured for a project. Use when you need to list all commands and their execution details for a specific project. |
| `DEPLOYHQ_GET_PROJECT_CONFIG_FILES` | Get Project Config Files | Tool to retrieve a list of all config files in a DeployHQ project. Use when you need to view all configuration files that are configured for a specific project. |
| `DEPLOYHQ_GET_PROJECT_DEPLOYMENTS` | Get Project Deployments | Tool to retrieve a paginated list of all deployments in a project. Use when you need to view deployment history for a specific project. Results are paginated with 10 deployments per page. |
| `DEPLOYHQ_GET_PROJECT_EXCLUDED_FILES` | Get Project Excluded Files | Tool to list all excluded files within a project template. Use when you need to view which files or patterns are excluded from deployment for a specific project. |
| `DEPLOYHQ_GET_CONFIG_FILE` | Get Config File | Tool to view a specific config file in a DeployHQ project. Use when you need to retrieve details about a particular configuration file by its identifier. |
| `DEPLOYHQ_GET_EXCLUDED_FILE` | Get Excluded File | Tool to view a specific excluded file in a DeployHQ project. Use when you need to retrieve details about a particular excluded file by its identifier. |
| `DEPLOYHQ_GET_SERVER_GROUP` | Get Server Group | Tool to view a specific server group in a DeployHQ project. Use when you need to retrieve details about a particular server group by its identifier. |
| `DEPLOYHQ_GET_PROJECT_REPOSITORY` | Get Project Repository | Tool to view repository details for a specific project in DeployHQ. Use when you need to retrieve repository configuration including URL, branch, and hosting service details. |
| `DEPLOYHQ_GET_REPOSITORY_BRANCHES` | Get Repository Branches | Tool to view all available branches in the connected repository for a project. Use when you need to list repository branches and their commit hashes. |
| `DEPLOYHQ_GET_REPOSITORY_COMMIT_INFO` | Get Repository Commit Info | Tool to view detailed information about a specific revision in a project's connected repository. Use when you need to retrieve commit details including author, timestamp, message, and tags. |
| `DEPLOYHQ_GET_LATEST_REPOSITORY_REVISION` | Get Latest Repository Revision | Tool to view the latest remote revision of your repository. Use when you need to get the most recent commit hash for a project's default branch or a specific branch. |
| `DEPLOYHQ_GET_RECENT_COMMITS_AND_TAGS` | 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. Use when you need to retrieve recent commit history and tag information from a project's repository branch. |
| `DEPLOYHQ_GET_PROJECT_SCHEDULED_DEPLOYMENTS` | Get Project Scheduled Deployments | Tool to retrieve all upcoming scheduled deployments for a project. Use when you need to view scheduled deployment configurations including server details, revision information, frequency settings, and execution times. |
| `DEPLOYHQ_GET_PROJECT_SERVER_GROUPS` | Get Project Server Groups | Tool to retrieve all server groups configured for a project. Use when you need to list servers and their deployment configurations within a project. |
| `DEPLOYHQ_GET_PROJECT_SERVERS` | Get Project Servers | Tool to retrieve all servers configured for a project. Use when you need to view server configurations and deployment targets for a specific project. |
| `DEPLOYHQ_GET_TEMPLATES` | Get Templates | Tool to retrieve all templates from DeployHQ account. Use when you need to list all configured templates and their identifiers. |
| `DEPLOYHQ_GET_PUBLIC_TEMPLATE` | Get Public Template | Tool to retrieve a specific public template from DeployHQ. Use when you need to view details of a public framework template using both template identifier and public template identifier. |
| `DEPLOYHQ_GET_PUBLIC_TEMPLATES` | Get Public Templates | Tool to retrieve publicly available deployment templates from DeployHQ. Use when you need to list framework templates for popular web platforms. |
| `DEPLOYHQ_UPDATE_PROJECT` | Update Project | Tool to update project settings in DeployHQ. Use when you need to modify a project's name or region/zone configuration. |
| `DEPLOYHQ_UPDATE_BUILD_CACHE_FILE` | Update Build Cache File | Tool to update an existing build cache file in a project. Use when you need to modify the path of a cached build artifact in the project's build cache storage. |
| `DEPLOYHQ_UPDATE_BUILD_COMMAND` | Update Build Command | Tool to update an existing build command in a project. Use when you need to modify the description, command, or error handling behavior of a build command. Supports partial updates - only include the fields you want to change. |
| `DEPLOYHQ_UPDATE_LANGUAGE_VERSION` | Update Language Version | Tool to update the version of a language in a project's build environment. Use when you need to change the version of PHP, Node.js, Python, Ruby, Java, Go, .NET, or Composer used in a project's build pipeline. |
| `DEPLOYHQ_UPDATE_PROJECT_COMMAND` | Update Project Command | Tool to update an existing SSH command in a project. Use when you need to modify command properties like description, command text, execution timing, timeout, or server assignments. |
| `DEPLOYHQ_UPDATE_CONFIG_FILE` | Update Config File | Tool to update an existing config file in a DeployHQ project. Use when you need to modify the path or contents of a configuration file. |
| `DEPLOYHQ_UPDATE_EXCLUDED_FILE` | Update Excluded File | Tool to update an existing excluded file rule in a project. Use when you need to modify the file path pattern or server associations for an excluded file in the deployment configuration. |
| `DEPLOYHQ_UPDATE_PROJECT_REPOSITORY` | Update Project Repository | Tool to update repository configuration for a project in DeployHQ. Use when you need to modify repository settings like branch, URL, SCM type, or authentication credentials. |
| `DEPLOYHQ_UPDATE_SERVER_GROUP` | Update Server Group | Tool to update an existing server group in a DeployHQ project. Use when you need to modify settings such as name, branch, auto-deploy, notification preferences, or deployment mode. Supports partial updates - only include the fields you want to change. |
| `DEPLOYHQ_UPDATE_TEMPLATE` | Update Template | Tool to update an existing template in DeployHQ. Use when you need to modify the name or description of a template. |
| `DEPLOYHQ_CREATE_PROJECT` | Create Project | Tool to create a new project in DeployHQ. Use when you need to initialize a new project with a name and optional zone configuration. |
| `DEPLOYHQ_GENERATE_AI_DEPLOYMENT_OVERVIEW` | Generate AI Deployment Overview | Tool to generate an AI-powered deployment overview for a revision range. Use when you need to analyze commit messages between two references and get a concise summary of changes. |
| `DEPLOYHQ_CREATE_BUILD_CACHE_FILE` | Create Build Cache File | Tool to create a new build cached file within a project. Use when you need to add a new cached build artifact to the project's build cache storage. |
| `DEPLOYHQ_CREATE_BUILD_COMMAND` | Create Build Command | Tool to create a new build command for a project in DeployHQ. Use when you need to add a new build command to a project. |
| `DEPLOYHQ_CREATE_PROJECT_BUILD_KNOWN_HOST` | Create Project Build Known Host | Tool to create a new known host in a project using DeployHQ API. Use when you need to add SSH known hosts for build processes in a specific project. |
| `DEPLOYHQ_CREATE_SSH_COMMAND` | Create SSH Command | Tool to create a new SSH command for a project in DeployHQ. Use when you need to add SSH commands that run before or after deployments. |
| `DEPLOYHQ_CREATE_CONFIG_FILE` | Create Config File | Tool to create a new config file in a DeployHQ project. Use when you need to add a configuration file that will be deployed to specified servers. |
| `DEPLOYHQ_CREATE_CONFIG_FILE_DEPLOYMENT` | Create Config File Deployment | Tool to create a new config file deployment for a project. Use when you need to deploy only configuration files to a server or server group without deploying code changes. |
| `DEPLOYHQ_CREATE_EXCLUDED_FILE` | Create Excluded File | Tool to add a new excluded file to a project. Use when you need to exclude specific files or patterns from deployment to prevent them from being deployed to servers. |
| `DEPLOYHQ_ABORT_DEPLOYMENT` | Abort Deployment | Tool to abort a currently running deployment. Use when you need to terminate a deployment that is in progress. |
| `DEPLOYHQ_ADD_PROJECT_REPOSITORY` | Add Project Repository | Tool to add repository details to a project in DeployHQ. Use when you need to configure a repository for a project with URL, SCM type, branch, and authentication credentials. |
| `DEPLOYHQ_CREATE_SERVER_GROUP` | Create Server Group | Tool to create a new server group for automated deployments in a DeployHQ project. Use when you need to set up a group of servers for deploying from a specific branch with auto-deploy and notification settings. |
| `DEPLOYHQ_CREATE_SERVER` | Create Server | Tool to create a new server configuration in a DeployHQ project. Use when you need to add a deployment destination with protocol-specific settings (SSH, FTP, S3, etc.). |
| `DEPLOYHQ_CREATE_TEMPLATE` | Create Template | Tool to create a new template in DeployHQ. Use when you need to create a template, optionally copying configuration from an existing project. |
| `DEPLOYHQ_UPDATE_PROJECT_SETTINGS` | Update Project Settings | Tool to update settings of an existing DeployHQ project. Use when you need to modify project properties like name, permalink, notification settings, or zone. Warning: Changing the permalink requires updating the repository webhook URL to maintain automatic deployments. |
| `DEPLOYHQ_EDIT_BUILD_CACHE_FILE` | Edit Build Cache File | Tool to edit an existing build cache file within a project. Use when you need to modify the path of a cached build artifact in the project's build cache storage. |
| `DEPLOYHQ_EDIT_BUILD_COMMAND` | Edit Build Command | Tool to edit an existing build command within a template in DeployHQ. Use when you need to modify the description, command, or error handling behavior of a build command. |
| `DEPLOYHQ_EDIT_SSH_COMMAND` | Edit SSH Command | Tool to edit an existing SSH command in a DeployHQ project. Use when you need to update command properties like description, command text, execution timing, timeout, or server assignments. |
| `DEPLOYHQ_EDIT_CONFIG_FILE` | Edit Config File | Tool to edit an existing config file within a project. Use when you need to modify the path, contents, or server deployment settings of a configuration file. |
| `DEPLOYHQ_EDIT_EXCLUDED_FILE` | Edit Excluded File | Tool to edit an existing excluded file rule within a project. Use when you need to modify the path pattern or server assignments of an existing exclusion rule. |
| `DEPLOYHQ_UPDATE_EXCLUDED_FILE` | Update Excluded File | Tool to update an existing excluded file rule in a project. Use when you need to modify the path pattern or server assignments of an existing exclusion rule. |
| `DEPLOYHQ_UPDATE_PROJECT_REPOSITORY` | Update Project Repository | Tool to update repository details for an existing project in DeployHQ. Use when you need to replace the complete repository configuration including SCM type, URL, and branch. |
| `DEPLOYHQ_UPDATE_SERVER_GROUP` | Update Server Group | Tool to update a server group in a DeployHQ project using the API. Use when you need to modify server group configuration such as name, branch, auto-deploy settings, notification preferences, or deployment mode. |
| `DEPLOYHQ_EDIT_TEMPLATE` | Edit Template | Tool to edit an existing template in DeployHQ. Use when you need to update the name or description of a template identified by its permalink. |

## Supported Triggers

None listed.

## Creating MCP Server - Stand-alone vs Composio SDK

The DeployHQ MCP server is an implementation of the Model Context Protocol that connects your AI agent to DeployHQ. It provides structured and secure access so your agent can perform DeployHQ operations on your behalf through a secure, permission-based interface.
With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster.

## Step-by-step Guide

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

### 1. Getting API Keys for OpenAI, Composio, and DeployHQ

No description provided.

### 2. Installing dependencies

No description provided.
```python
pip install composio-llamaindex llama-index llama-index-llms-openai llama-index-tools-mcp python-dotenv
```

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

### 3. Set environment variables

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
```bash
OPENAI_API_KEY=your-openai-api-key
COMPOSIO_API_KEY=your-composio-api-key
COMPOSIO_USER_ID=your-user-id
```

### 4. Import modules

No description provided.
```python
import asyncio
import os
import dotenv

from composio import Composio
from composio_llamaindex import LlamaIndexProvider
from llama_index.core.agent.workflow import ReActAgent
from llama_index.core.workflow import Context
from llama_index.llms.openai import OpenAI
from llama_index.tools.mcp import BasicMCPClient, McpToolSpec

dotenv.load_dotenv()
```

```typescript
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();
```

### 5. Load environment variables and initialize Composio

No description provided.
```python
OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not OPENAI_API_KEY:
    raise ValueError("OPENAI_API_KEY is not set in the environment")
if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set in the environment")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set in the environment")
```

```typescript
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");
```

### 6. Create a Tool Router session and build the agent function

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.
```python
async def build_agent() -> ReActAgent:
    composio_client = Composio(
        api_key=COMPOSIO_API_KEY,
        provider=LlamaIndexProvider(),
    )

    session = composio_client.create(
        user_id=COMPOSIO_USER_ID,
        toolkits=["deployhq"],
    )

    mcp_url = session.mcp.url
    print(f"Composio MCP URL: {mcp_url}")

    mcp_client = BasicMCPClient(mcp_url, headers={"x-api-key": COMPOSIO_API_KEY})
    mcp_tool_spec = McpToolSpec(client=mcp_client)
    tools = await mcp_tool_spec.to_tool_list_async()

    llm = OpenAI(model="gpt-5")

    description = "An agent that uses Composio Tool Router MCP tools to perform DeployHQ actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform DeployHQ actions.
    """
    return ReActAgent(tools=tools, llm=llm, description=description, system_prompt=system_prompt, verbose=True)
```

```typescript
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;
}
```

### 7. Create an interactive chat loop

No description provided.
```python
async def chat_loop(agent: ReActAgent) -> None:
    ctx = Context(agent)
    print("Type 'quit', 'exit', or Ctrl+C to stop.")

    while True:
        try:
            user_input = input("\nYou: ").strip()
        except (KeyboardInterrupt, EOFError):
            print("\nBye!")
            break

        if not user_input or user_input.lower() in {"quit", "exit"}:
            print("Bye!")
            break

        try:
            print("Agent: ", end="", flush=True)
            handler = agent.run(user_input, ctx=ctx)

            async for event in handler.stream_events():
                # Stream token-by-token from LLM responses
                if hasattr(event, "delta") and event.delta:
                    print(event.delta, end="", flush=True)
                # Show tool calls as they happen
                elif hasattr(event, "tool_name"):
                    print(f"\n[Using tool: {event.tool_name}]", flush=True)

            # Get final response
            response = await handler
            print()  # Newline after streaming
        except KeyboardInterrupt:
            print("\n[Interrupted]")
            continue
        except Exception as e:
            print(f"\nError: {e}")
```

```typescript
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();
}
```

### 8. Define the main entry point

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
```python
async def main() -> None:
    agent = await build_agent()
    await chat_loop(agent)

if __name__ == "__main__":
    # Handle Ctrl+C gracefully
    signal.signal(signal.SIGINT, lambda s, f: (print("\nBye!"), exit(0)))
    try:
        asyncio.run(main())
    except KeyboardInterrupt:
        print("\nBye!")
```

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

main();
```

### 9. Run the agent

When prompted, authenticate and authorise your agent with DeployHQ, then start asking questions.
```bash
python llamaindex_agent.py
```

```typescript
npx ts-node llamaindex-agent.ts
```

## Complete Code

```python
import asyncio
import os
import signal
import dotenv

from composio import Composio
from composio_llamaindex import LlamaIndexProvider
from llama_index.core.agent.workflow import ReActAgent
from llama_index.core.workflow import Context
from llama_index.llms.openai import OpenAI
from llama_index.tools.mcp import BasicMCPClient, McpToolSpec

dotenv.load_dotenv()

OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not OPENAI_API_KEY:
    raise ValueError("OPENAI_API_KEY is not set")
if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set")

async def build_agent() -> ReActAgent:
    composio_client = Composio(
        api_key=COMPOSIO_API_KEY,
        provider=LlamaIndexProvider(),
    )

    session = composio_client.create(
        user_id=COMPOSIO_USER_ID,
        toolkits=["deployhq"],
    )

    mcp_url = session.mcp.url
    print(f"Composio MCP URL: {mcp_url}")

    mcp_client = BasicMCPClient(mcp_url, headers={"x-api-key": COMPOSIO_API_KEY})
    mcp_tool_spec = McpToolSpec(client=mcp_client)
    tools = await mcp_tool_spec.to_tool_list_async()

    llm = OpenAI(model="gpt-5")
    description = "An agent that uses Composio Tool Router MCP tools to perform DeployHQ actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform DeployHQ actions.
    """
    return ReActAgent(
        tools=tools,
        llm=llm,
        description=description,
        system_prompt=system_prompt,
        verbose=True,
    );

async def chat_loop(agent: ReActAgent) -> None:
    ctx = Context(agent)
    print("Type 'quit', 'exit', or Ctrl+C to stop.")

    while True:
        try:
            user_input = input("\nYou: ").strip()
        except (KeyboardInterrupt, EOFError):
            print("\nBye!")
            break

        if not user_input or user_input.lower() in {"quit", "exit"}:
            print("Bye!")
            break

        try:
            print("Agent: ", end="", flush=True)
            handler = agent.run(user_input, ctx=ctx)

            async for event in handler.stream_events():
                # Stream token-by-token from LLM responses
                if hasattr(event, "delta") and event.delta:
                    print(event.delta, end="", flush=True)
                # Show tool calls as they happen
                elif hasattr(event, "tool_name"):
                    print(f"\n[Using tool: {event.tool_name}]", flush=True)

            # Get final response
            response = await handler
            print()  # Newline after streaming
        except KeyboardInterrupt:
            print("\n[Interrupted]")
            continue
        except Exception as e:
            print(f"\nError: {e}")

async def main() -> None:
    agent = await build_agent()
    await chat_loop(agent)

if __name__ == "__main__":
    # Handle Ctrl+C gracefully
    signal.signal(signal.SIGINT, lambda s, f: (print("\nBye!"), exit(0)))
    try:
        asyncio.run(main())
    except KeyboardInterrupt:
        print("\nBye!")
```

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

## How to build DeployHQ MCP Agent with another framework

- [OpenAI Agents SDK](https://composio.dev/toolkits/deployhq/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/deployhq/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/deployhq/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/deployhq/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/deployhq/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/deployhq/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/deployhq/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/deployhq/framework/cli)
- [Google ADK](https://composio.dev/toolkits/deployhq/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/deployhq/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/deployhq/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/deployhq/framework/mastra-ai)
- [CrewAI](https://composio.dev/toolkits/deployhq/framework/crew-ai)

## Related Toolkits

- [Supabase](https://composio.dev/toolkits/supabase) - 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](https://composio.dev/toolkits/codeinterpreter) - 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](https://composio.dev/toolkits/github) - 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.
- [Ably](https://composio.dev/toolkits/ably) - Ably is a real-time messaging platform for live chat and data sync in modern apps. It offers global scale and rock-solid reliability for seamless, instant experiences.
- [Abuselpdb](https://composio.dev/toolkits/abuselpdb) - Abuselpdb is a central database for reporting and checking IPs linked to malicious online activity. Use it to quickly identify and report suspicious or abusive IP addresses.
- [Alchemy](https://composio.dev/toolkits/alchemy) - Alchemy is a blockchain development platform offering APIs and tools for Ethereum apps. It simplifies building and scaling Web3 projects with robust infrastructure.
- [Algolia](https://composio.dev/toolkits/algolia) - Algolia is a hosted search API that powers lightning-fast, relevant search experiences for web and mobile apps. It helps developers deliver instant, typo-tolerant, and scalable search without complex infrastructure.
- [Anchor browser](https://composio.dev/toolkits/anchor_browser) - Anchor browser is a developer platform for AI-powered web automation. It transforms complex browser actions into easy API endpoints for streamlined web interaction.
- [Apiflash](https://composio.dev/toolkits/apiflash) - Apiflash is a website screenshot API for programmatically capturing web pages. It delivers high-quality screenshots on demand for automation, monitoring, or reporting.
- [Apiverve](https://composio.dev/toolkits/apiverve) - Apiverve delivers a suite of powerful APIs that simplify integration for developers. It's designed for reliability and scalability so you can build faster, smarter applications without the integration headache.
- [Appcircle](https://composio.dev/toolkits/appcircle) - Appcircle is an enterprise-grade mobile CI/CD platform for building, testing, and publishing mobile apps. It streamlines mobile DevOps so teams ship faster and with more confidence.
- [Appdrag](https://composio.dev/toolkits/appdrag) - Appdrag is a cloud platform for building websites, APIs, and databases with drag-and-drop tools and code editing. It accelerates development and iteration by combining hosting, database management, and low-code features in one place.
- [Appveyor](https://composio.dev/toolkits/appveyor) - AppVeyor is a cloud-based continuous integration service for building, testing, and deploying applications. It helps developers automate and streamline their software delivery pipelines.
- [Backendless](https://composio.dev/toolkits/backendless) - Backendless is a backend-as-a-service platform for mobile and web apps, offering database, file storage, user authentication, and APIs. It helps developers ship scalable applications faster without managing server infrastructure.
- [Baserow](https://composio.dev/toolkits/baserow) - Baserow is an open-source no-code database platform for building collaborative data apps. It makes it easy for teams to organize data and automate workflows without writing code.
- [Bench](https://composio.dev/toolkits/bench) - Bench is a benchmarking tool for automated performance measurement and analysis. It helps you quickly evaluate, compare, and track your systems or workflows.
- [Better stack](https://composio.dev/toolkits/better_stack) - Better Stack is a monitoring, logging, and incident management solution for apps and services. It helps teams ensure application reliability and performance with real-time insights.
- [Bitbucket](https://composio.dev/toolkits/bitbucket) - Bitbucket is a Git-based code hosting and collaboration platform for teams. It enables secure repository management and streamlined code reviews.
- [Blazemeter](https://composio.dev/toolkits/blazemeter) - Blazemeter is a continuous testing platform for web and mobile app performance. It empowers teams to automate and analyze large-scale tests with ease.
- [Blocknative](https://composio.dev/toolkits/blocknative) - Blocknative delivers real-time mempool monitoring and transaction management for public blockchains. Instantly track pending transactions and optimize blockchain interactions with live data.

## Frequently Asked Questions

### What are the differences in Tool Router MCP and DeployHQ MCP?

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.

### Can I use Tool Router MCP with LlamaIndex?

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.

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

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.

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

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)