How to integrate Ngrok MCP with Claude Agent SDK

Trusted by
AWS
Glean
Zoom
Airtable

30 min · no commitment · see it on your stack

Ngrok logo
Claude Agent SDK logo
divider

Introduction

This guide walks you through connecting Ngrok to the Claude Agent SDK using the Composio tool router. By the end, you'll have a working Ngrok agent that can list all active tunnels and endpoints, show https edges currently configured, list all api keys for your account through natural language commands.

This guide will help you understand how to give your Claude Agent SDK agent real control over a Ngrok account through Composio's Ngrok MCP server.

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

Also integrate Ngrok with

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 Ngrok
  • Configure an AI agent that can use Ngrok as a tool
  • Run a live chat session where you can ask the agent to perform Ngrok 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 Ngrok MCP server, and what's possible with it?

The Ngrok MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Ngrok account. It provides structured and secure access to your Ngrok tunnels and API keys, so your agent can perform actions like managing endpoints, listing tunnels, handling API keys, and auditing IP restrictions on your behalf.

  • Active tunnel and endpoint monitoring: Instantly list all active tunnels and endpoints in your Ngrok account, making it simple to track running services and public URLs.
  • API key management: Programmatically create, list, and delete API keys to securely manage who and what can access your Ngrok resources.
  • HTTPS edge configuration visibility: Retrieve a comprehensive list of all HTTPS edges to review and manage how Ngrok handles encrypted traffic.
  • IP restriction and policy auditing: List and inspect all IP restrictions and policy rules, helping you enforce access control and security best practices.
  • Detailed access audit trails: Fetch details about specific IP restrictions for security audits and compliance, ensuring you always know who can access your tunnels and APIs.

Supported Tools & Triggers

Tools
Create API KeyCreates a new API key for authenticating with the ngrok API.
Create Tunnel CredentialCreates a new tunnel authtoken credential for authenticating ngrok agents.
Create EndpointCreate a cloud endpoint on the ngrok account.
Create Event SourceAdd a new event source to an event subscription.
Create Event SubscriptionCreates a new event subscription in ngrok.
Create HTTPS EdgeCreates a new HTTPS edge in your ngrok account.
Create HTTPS Edge RouteCreates a new route on an HTTPS edge in ngrok.
Create SSH CredentialCreates a new SSH credential from an uploaded public SSH key.
Create VaultCreates a new vault in your ngrok account.
Create Vault SecretTool to create a new secret in an ngrok vault for secure storage of sensitive data like API keys, passwords, or tokens.
Delete API KeyDelete an API key by its ID.
Delete CredentialsDelete a tunnel authtoken credential by ID.
Delete HTTPS Edge Route Circuit Breaker ModuleDelete the Circuit Breaker module from an HTTPS Edge Route.
Delete Edge Route Compression ModuleDelete the compression module from an HTTPS edge route.
Delete Edge Route Request Headers ModuleDelete the request headers module from an HTTPS edge route.
Delete Edge Route Response Headers ModuleDelete the response headers module from an HTTPS edge route.
Delete Edge Route SAML ModuleDelete the SAML module configuration from an HTTPS edge route.
Delete Edge Route User Agent Filter ModuleDelete the user agent filter module from an HTTPS edge route.
Delete Edge Route Webhook Verification ModuleDelete the webhook verification module from an HTTPS edge route.
Delete Edge Route WebSocket TCP Converter ModuleDelete the WebSocket TCP converter module from an HTTPS edge route.
Delete EndpointDelete an endpoint by ID.
Delete Event SourceDelete an event source from an event subscription.
Delete Event SubscriptionDelete an event subscription by ID.
Delete HTTPS EdgeDelete an HTTPS edge by ID.
Delete HTTPS Edge RouteDelete an HTTPS edge route by ID.
Delete Reserved Domain CertificateDetach the certificate attached to a reserved domain.
Delete Reserved Domain Certificate Management PolicyDetach the certificate management policy from a reserved domain.
Delete SecretDelete a vault secret by ID.
Delete SSH CredentialsDelete an SSH credential by ID.
Delete VaultDelete a vault by ID.
Get API KeyGet the details of an API key by ID.
Get CredentialsTool to retrieve detailed information about a tunnel authtoken credential by ID.
Get Edge Route Backend ModuleRetrieves the backend module configuration for an HTTPS edge route.
Get Edge Route Circuit Breaker ModuleTool to retrieve the circuit breaker module configuration for a specific HTTPS edge route.
Get Edge Route Compression ModuleRetrieves the compression module configuration for a specific HTTPS edge route.
Get Edge Route IP Restriction ModuleRetrieves the IP restriction module configuration for a specific HTTPS edge route.
Get Edge Route OIDC ModuleRetrieves the OIDC (OpenID Connect) module configuration for a specific HTTPS edge route.
Get Edge Route Request Headers ModuleRetrieves the request headers module configuration for a specific HTTPS edge route.
Get Edge Route Response Headers ModuleGet the response headers module configuration for an HTTPS edge route.
Get Edge Route SAML ModuleRetrieves the SAML authentication module configuration for a specific HTTPS edge route.
Get Edge Route Traffic PolicyRetrieves the Traffic Policy module configuration for a specific HTTPS edge route.
Get Edge Route User Agent Filter ModuleRetrieves the user agent filter module configuration for a specific HTTPS edge route.
Get Edge Route Webhook Verification ModuleRetrieves the webhook verification module configuration for an HTTPS edge route.
Get Edge Route WebSocket TCP Converter ModuleRetrieves the WebSocket TCP Converter module configuration for a specific HTTPS edge route.
Get EndpointGet the status of an endpoint by ID.
Get Event SourceGet an event source by type for a specific event subscription.
Get HTTPS EdgeGet the details of an HTTPS edge by ID.
Get HTTPS Edge Mutual TLS ModuleRetrieves the mutual TLS module configuration for an HTTPS edge.
Get HTTPS Edge RouteRetrieves detailed information about a specific HTTPS edge route by its ID.
Get IP Restriction DetailsRetrieves detailed information about a specific IP restriction by its ID.
Get Reserved DomainGet the details of a reserved domain by ID.
Get SecretTool to retrieve detailed information about a vault secret by ID.
Get Secrets by VaultTool to get all secrets in a vault by vault ID.
Get SSH CredentialsTool to retrieve detailed information about an SSH credential by ID.
Get VaultGet the details of a vault by ID.
List Agent IngressesList all Agent Ingresses owned by this account.
List API KeysThis tool lists all API keys owned by the user.
List Bot UsersTool to list all bot users on this ngrok account.
List Certificate AuthoritiesList all certificate authorities on this account.
List Tunnel CredentialsList all tunnel authtoken credentials on the ngrok account.
List All EndpointsList all active endpoints on the ngrok account.
List Event DestinationsList all Event Destinations on the ngrok account.
List Event SubscriptionsList all event subscriptions on the ngrok account.
List Event Subscription SourcesTool to list the types for which this event subscription will trigger.
List Failover BackendsList all failover backends on this account.
List HTTP Response BackendsList all HTTP response backends on the account.
List HTTPS EdgesLists all HTTPS Edges in your ngrok account.
List IP PoliciesList all IP policies on this account.
List IP Policy RulesThis tool lists all IP policy rules associated with your ngrok account.
List IP RestrictionsLists all IP restrictions configured on the ngrok account.
List Reserved AddressesList all reserved addresses on this account.
List Reserved DomainsList all reserved domains on this account.
List Service UsersTool to list all service users on this ngrok account.
List SSH Certificate AuthoritiesList all SSH Certificate Authorities on this account.
List SSH CredentialsList all SSH credentials on the ngrok account.
List SSH Host CertificatesList all SSH Host Certificates issued on this account.
List SSH User CertificatesList all SSH user certificates on the ngrok account.
List Static BackendsList all static backends on the account.
List TCP EdgesLists all TCP Edges in your ngrok account.
List TLS CertificatesList all TLS certificates on the ngrok account.
List TLS EdgesLists all TLS Edges in your ngrok account.
List Active TunnelsList all active tunnels in the ngrok account.
List Tunnel SessionsList all online tunnel sessions running on this account.
List VaultsList all vaults owned by the ngrok account.
List Vault SecretsList all vault secrets owned by the ngrok account.
List Weighted BackendsList all weighted backends on the ngrok account.
Replace Edge Route Circuit Breaker ModuleReplaces the circuit breaker module configuration on an HTTPS edge route.
Replace Edge Route Compression ModuleReplaces the compression module configuration for an HTTPS edge route.
Replace Edge Route Request Headers ModuleReplaces the request headers module configuration for an HTTPS edge route.
Replace Edge Route Response Headers ModuleReplaces the response headers module configuration for an HTTPS edge route.
Replace Edge Route Traffic PolicyReplaces the traffic policy module on an HTTPS edge route.
Replace Edge Route User Agent Filter ModuleReplaces the user agent filter module configuration for an HTTPS edge route.
Replace Edge Route Webhook Verification ModuleReplaces the webhook verification module configuration for an HTTPS edge route.
Update API KeyUpdates attributes of an API key by ID.
Update CredentialsTool to update attributes of a tunnel authtoken credential by ID.
Update EndpointTool to update an Endpoint by ID, currently available only for cloud endpoints.
Update Event SubscriptionTool to update attributes of an event subscription by ID.
Update HTTPS Edge RouteTool to update an HTTPS edge route by ID.
Update Reserved DomainTool to update the attributes of a reserved domain by ID.
Update SecretTool to update a vault secret by ID.
Update SSH CredentialTool to update attributes of an SSH credential by ID.
Update VaultTool to update attributes of a vault by ID.

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

Prerequisites

Before starting, make sure you have:
  • Composio API Key and Claude/Anthropic API Key
  • Primary know-how of Claude Agents SDK
  • A Ngrok 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 Ngrok 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 Ngrok
    mcp_server = composio.create(
        user_id=os.getenv("USER_ID"),
        toolkits=["ngrok"]
    )

    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 Ngrok
  • 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 Ngrok 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 Ngrok
  • 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 Ngrok 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 Ngrok
    mcp_server = composio.create(
        user_id=os.getenv("USER_ID"),
        toolkits=["ngrok"]
    )

    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 Ngrok 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 Ngrok 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 Ngrok MCP Agent with another framework

FAQ

What are the differences in Tool Router MCP and Ngrok MCP?

With a standalone Ngrok MCP server, the agents and LLMs can only access a fixed set of Ngrok tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Ngrok 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 Ngrok tools.

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

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