How to integrate DeployHQ MCP with Claude Agent SDK

GET STARTED FOR FREE
Framework Integration Gradient
DeployHQ Logo
Claude Agent SDK Logo
divider

Introduction

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

TL;DR

Here's what you'll learn:
  • Get and set up your Claude/Anthropic 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 Claude Agent SDK?

The Claude Agent SDK is Anthropic's official framework for building AI agents powered by Claude. It provides a streamlined interface for creating agents with MCP tool support and conversation management.

Key features include:

  • Native MCP Support: Built-in support for Model Context Protocol servers
  • Permission Modes: Control tool execution permissions
  • Streaming Responses: Real-time response streaming for interactive applications
  • Context Manager: Clean async context management for sessions

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 & Triggers

Tools
Delete CommandTool to delete a command from a specified project.
Delete ProjectTool to delete a project from DeployHQ.
Delete Build Cache FileTool to delete an existing build cache file from a project.
Delete Excluded File RuleTool to delete an existing excluded file rule from a project.
Delete Server GroupTool to delete a server group from a project using the DeployHQ API.
Delete TemplateTool to delete a template by its unique permalink.
Get ProjectsTool to retrieve all projects from DeployHQ account.
Get ProjectTool to view an existing project in DeployHQ.
Get Project Build Known HostsTool to list all known hosts within a project using DeployHQ API.
Get Project CommandsTool to retrieve all SSH commands configured for a project.
Get Project Config FilesTool to retrieve a list of all config files in a DeployHQ project.
Get Project DeploymentsTool to retrieve a paginated list of all deployments in a project.
Get Project Excluded FilesTool to list all excluded files within a project template.
Get Config FileTool to view a specific config file in a DeployHQ project.
Get Excluded FileTool to view a specific excluded file in a DeployHQ project.
Get Server GroupTool to view a specific server group in a DeployHQ project.
Get Project RepositoryTool to view repository details for a specific project in DeployHQ.
Get Repository BranchesTool to view all available branches in the connected repository for a project.
Get Repository Commit InfoTool to view detailed information about a specific revision in a project's connected repository.
Get Latest Repository RevisionTool to view the latest remote revision of your repository.
Get Recent Commits and TagsTool to view up to 15 most recent revisions and up to 15 most recent tags in a specific branch.
Get Project Scheduled DeploymentsTool to retrieve all upcoming scheduled deployments for a project.
Get Project Server GroupsTool to retrieve all server groups configured for a project.
Get Project ServersTool to retrieve all servers configured for a project.
Get TemplatesTool to retrieve all templates from DeployHQ account.
Get Public TemplateTool to retrieve a specific public template from DeployHQ.
Get Public TemplatesTool to retrieve publicly available deployment templates from DeployHQ.
Update ProjectTool to update project settings in DeployHQ.
Update Build Cache FileTool to update an existing build cache file in a project.
Update Build CommandTool to update an existing build command in a project.
Update Language VersionTool to update the version of a language in a project's build environment.
Update Project CommandTool to update an existing SSH command in a project.
Update Config FileTool to update an existing config file in a DeployHQ project.
Update Excluded FileTool to update an existing excluded file rule in a project.
Update Project RepositoryTool to update repository configuration for a project in DeployHQ.
Update Server GroupTool to update an existing server group in a DeployHQ project.
Update TemplateTool to update an existing template in DeployHQ.
Create ProjectTool to create a new project in DeployHQ.
Generate AI Deployment OverviewTool to generate an AI-powered deployment overview for a revision range.
Create Build Cache FileTool to create a new build cached file within a project.
Create Build CommandTool to create a new build command for a project in DeployHQ.
Create Project Build Known HostTool to create a new known host in a project using DeployHQ API.
Create SSH CommandTool to create a new SSH command for a project in DeployHQ.
Create Config FileTool to create a new config file in a DeployHQ project.
Create Config File DeploymentTool to create a new config file deployment for a project.
Create Excluded FileTool to add a new excluded file to a project.
Abort DeploymentTool to abort a currently running deployment.
Add Project RepositoryTool to add repository details to a project in DeployHQ.
Create Server GroupTool to create a new server group for automated deployments in a DeployHQ project.
Create ServerTool to create a new server configuration in a DeployHQ project.
Create TemplateTool to create a new template in DeployHQ.
Update Project SettingsTool to update settings of an existing DeployHQ project.
Edit Build Cache FileTool to edit an existing build cache file within a project.
Edit Build CommandTool to edit an existing build command within a template in DeployHQ.
Edit SSH CommandTool to edit an existing SSH command in a DeployHQ project.
Edit Config FileTool to edit an existing config file within a project.
Edit Excluded FileTool to edit an existing excluded file rule within a project.
Update Excluded FileTool to update an existing excluded file rule in a project.
Update Project RepositoryTool to update repository details for an existing project in DeployHQ.
Update Server GroupTool to update a server group in a DeployHQ project using the API.
Edit TemplateTool to edit an existing template in DeployHQ.

What is the Composio tool router, and how does it fit here?

What is Tool Router?

Composio's Tool Router 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 Tool Router

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Tool Router works

The Tool Router follows a three-phase workflow:

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

Step-by-step Guide

Prerequisites

Before starting, make sure you have:
  • Composio API Key and Claude/Anthropic API Key
  • Primary know-how of Claude Agents SDK
  • A DeployHQ account
  • Some knowledge of Python

Getting API Keys for Claude/Anthropic and Composio

Claude/Anthropic API Key
  • Go to the Anthropic Console and create an API key. You'll need credits to use the models.
  • Keep the API key safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Navigate to your API settings and generate a new API key.
  • Store this key securely as you'll need it for authentication.

Install dependencies

pip install composio-anthropic claude-agent-sdk python-dotenv

Install the Composio SDK and the Claude Agents SDK.

What's happening:

  • composio-anthropic provides Composio integration for Anthropic
  • claude-agent-sdk is the core agent framework
  • python-dotenv loads environment variables

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
ANTHROPIC_API_KEY=your_anthropic_api_key_here

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates with Composio
  • USER_ID identifies the user for session management
  • ANTHROPIC_API_KEY authenticates with Anthropic/Claude

Import dependencies

import asyncio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions
import os
from composio import Composio
from dotenv import load_dotenv

load_dotenv()
What's happening:
  • We're importing all necessary libraries including the Claude Agent SDK and Composio
  • The load_dotenv() function loads environment variables from your .env file
  • This setup prepares the foundation for connecting Claude with DeployHQ functionality

Create a Composio instance and Tool Router session

async def chat_with_remote_mcp():
    api_key = os.getenv("COMPOSIO_API_KEY")
    if not api_key:
        raise RuntimeError("COMPOSIO_API_KEY is not set")

    composio = Composio(api_key=api_key)

    # Create Tool Router session for DeployHQ
    mcp_server = composio.create(
        user_id=os.getenv("USER_ID"),
        toolkits=["deployhq"]
    )

    url = mcp_server.mcp.url

    if not url:
        raise ValueError("Session URL not found")
What's happening:
  • The function checks for the required COMPOSIO_API_KEY environment variable
  • We're creating a Composio instance using our API key
  • The create method creates a Tool Router session for DeployHQ
  • The returned url is the MCP server URL that your agent will use

Configure Claude Agent with MCP

# Configure remote MCP server for Claude
options = ClaudeAgentOptions(
    permission_mode="bypassPermissions",
    mcp_servers={
        "composio": {
            "type": "http",
            "url": url,
            "headers": {
                "x-api-key": os.getenv("COMPOSIO_API_KEY")
            }
        }
    },
    system_prompt="You are a helpful assistant with access to DeployHQ tools via Composio.",
    max_turns=10
)
What's happening:
  • We're configuring the Claude Agent options with the MCP server URL
  • permission_mode="bypassPermissions" allows the agent to execute operations without asking for permission each time
  • The system prompt instructs the agent that it has access to DeployHQ
  • max_turns=10 limits the conversation length to prevent excessive API usage

Create client and start chat loop

# Create client with context manager
async with ClaudeSDKClient(options=options) as client:
    print("\nChat started. Type 'exit' or 'quit' to end.\n")

    # Main chat loop
    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit"}:
            print("Goodbye!")
            break

        # Send query
        await client.query(user_input)

        # Receive and print response
        print("Claude: ", end="", flush=True)
        async for message in client.receive_response():
            if hasattr(message, "content"):
                for block in message.content:
                    if hasattr(block, "text"):
                        print(block.text, end="", flush=True)
        print()
What's happening:
  • The Claude SDK client is created using the async context manager pattern
  • The agent processes each query and streams the response back in real-time
  • The chat loop continues until the user types 'exit' or 'quit'

Run the application

if __name__ == "__main__":
    asyncio.run(chat_with_remote_mcp())
What's happening:
  • This entry point runs the async chat_with_remote_mcp() function using asyncio.run()
  • The application will start, create the MCP connection, and begin the interactive chat session

Complete Code

Here's the complete code to get you started with DeployHQ and Claude Agent SDK:

import asyncio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions
import os
from composio import Composio
from dotenv import load_dotenv

load_dotenv()

async def chat_with_remote_mcp():
    api_key = os.getenv("COMPOSIO_API_KEY")
    if not api_key:
        raise RuntimeError("COMPOSIO_API_KEY is not set")

    composio = Composio(api_key=api_key)

    # Create Tool Router session for DeployHQ
    mcp_server = composio.create(
        user_id=os.getenv("USER_ID"),
        toolkits=["deployhq"]
    )

    url = mcp_server.mcp.url

    if not url:
        raise ValueError("Session URL not found")

    # Configure remote MCP server for Claude
    options = ClaudeAgentOptions(
        permission_mode="bypassPermissions",
        mcp_servers={
            "composio": {
                "type": "http",
                "url": url,
                "headers": {
                    "x-api-key": os.getenv("COMPOSIO_API_KEY")
                }
            }
        },
        system_prompt="You are a helpful assistant with access to DeployHQ tools via Composio.",
        max_turns=10
    )

    # Create client with context manager
    async with ClaudeSDKClient(options=options) as client:
        print("\nChat started. Type 'exit' or 'quit' to end.\n")

        # Main chat loop
        while True:
            user_input = input("You: ").strip()
            if user_input.lower() in {"exit", "quit"}:
                print("Goodbye!")
                break

            # Send query
            await client.query(user_input)

            # Receive and print response
            print("Claude: ", end="", flush=True)
            async for message in client.receive_response():
                if hasattr(message, "content"):
                    for block in message.content:
                        if hasattr(block, "text"):
                            print(block.text, end="", flush=True)
            print()

if __name__ == "__main__":
    asyncio.run(chat_with_remote_mcp())

Conclusion

You've successfully built a Claude Agent SDK agent that can interact with DeployHQ through Composio's Tool Router.

Key features:

  • Native MCP support through Claude's agent framework
  • Streaming responses for real-time interaction
  • Permission bypass for smooth automated workflows
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.

How to build DeployHQ MCP Agent with another framework

OpenAI Agents SDK

OpenAI Agents SDK

Use DeployHQ MCP with OpenAI Agents SDK

Google ADK

Google ADK

Use DeployHQ MCP with Google ADK

LangChain

LangChain

Use DeployHQ MCP with LangChain

Vercel AI SDK

Vercel AI SDK

Use DeployHQ MCP with Vercel AI SDK

Mastra AI

Mastra AI

Use DeployHQ MCP with Mastra AI

LlamaIndex

LlamaIndex

Use DeployHQ MCP with LlamaIndex

CrewAI

CrewAI

Use DeployHQ MCP with CrewAI

Claude Code

Claude Code

Use DeployHQ MCP with Claude Code

Codex

Codex

Use DeployHQ MCP with Codex

FAQ

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 Claude Agent SDK?

Yes, you can. Claude Agent 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.

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.

Used by agents from

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

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Book a call↗Get started for free