Ngrok with OpenAI Agents SDK

How to integrate Ngrok MCP with OpenAI Agents SDK

Trusted by

GET STARTED FOR FREE GET A DEMO

30 min · no commitment · see it on your stack

Introduction Also integrate Ngrok with TL;DR What is OpenAI Agents SDK What is the Ngrok MCP server Supported Tools & Triggers Creating MCP Server - Stand-alone vs Composio SDK Step-by-step Guide Complete Code Conclusion How to build Ngrok MCP Agent with another framework Explore Other Toolkits FAQ

Connect Ngrok without Auth hassles

We manage OAuth, API Key, token refresh, and scopes, you just build.

Try for Free

Introduction

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

Claude Agent SDK Claude Code Claude Cowork Codex OpenClaw Hermes CLI Google ADK LangChain Vercel AI SDK Mastra AI LlamaIndex CrewAI

TL;DR

Here's what you'll learn:

Get and set up your OpenAI and Composio API keys
Install the necessary dependencies
Initialize Composio and create a Tool Router session for 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 OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

Hosted MCP Tools: Connect to external services through hosted MCP endpoints
SQLite Sessions: Persist conversation history across interactions
Simple API: Clean interface with Agent, Runner, and tool configuration
Streaming Support: Real-time response streaming for interactive applications

What is the 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:

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

Step-by-step Guide

Prerequisites

Before starting, make sure you have:

Composio API Key and OpenAI API Key
Primary know-how of OpenAI Agents SDK
A live Ngrok project
Some knowledge of Python or Typescript

Getting API Keys for OpenAI and Composio

OpenAI API Key

Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
Keep the API key safe.

Composio API Key

Log in to the Composio dashboard.
Go to Settings and copy your API key.

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

Set up environment variables

bash

OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

What's happening:

You're importing all necessary libraries.
The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Ngrok.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

What's happening:

load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Ngrok Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["ngrok"]
)

mcp_url = session.mcp.url

What is happening:

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

Configure the agent

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Ngrok. "
        "Help users perform Ngrok operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

What's happening:

We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
The agent's instructions tell it that it can access Ngrok and help with queries, inserts, updates, authentication, and fetching database information.
The tools array includes a HostedMCPTool that connects to the MCP server URL we created earlier.
The headers dict includes the Composio API key for secure authentication with the MCP server.
require_approval: 'never' means the agent can execute Ngrok operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

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

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

What's happening:

The program prints a session URL that you visit to authorize Ngrok.
After authorization, the chat begins.
Each message you type is processed by the agent using Runner.run().
The responses are printed to the console, and conversations are saved locally using SQLite.
Typing exit, quit, or q cleanly ends the chat.

Complete Code

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

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["ngrok"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Ngrok. "
        "Help users perform Ngrok operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

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

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

Conclusion

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

Key features:

Hosted MCP tool integration through Composio's Tool Router
SQLite session persistence for conversation history
Simple async chat loop for interactive testing

You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.

How to build Ngrok MCP Agent with another framework

Claude Agent SDK

Use Ngrok MCP with Claude Agent SDK

Claude Code

Use Ngrok MCP with Claude Code

Claude Cowork

Use Ngrok MCP with Claude Cowork

Codex

Use Ngrok MCP with Codex

OpenClaw

Use Ngrok MCP with OpenClaw

Hermes

Use Ngrok MCP with Hermes

CLI

Use Ngrok MCP with CLI

Google ADK

Use Ngrok MCP with Google ADK

LangChain

Use Ngrok MCP with LangChain

Vercel AI SDK

Use Ngrok MCP with Vercel AI SDK

Mastra AI

Use Ngrok MCP with Mastra AI

LlamaIndex

Use Ngrok MCP with LlamaIndex

CrewAI

Use Ngrok MCP with CrewAI

Explore Other Toolkits

Supabase

Oauth2Api Key

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

No Auth

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

Oauth2

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.

TOOLKIT MARKETPLACE

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 OpenAI Agents SDK?

Yes, you can. OpenAI Agents SDK fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right 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

Never worry about agent reliability

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

Get started for free Get a demo↗

Harsha GaddipatiCo-founder, Slashy

Karan skipped his own birthday party to fix our critical issue. It was 10 pm and he diverted his Waymo to help us instead. This really sets the bar, shows you the commitment you need to have when users rely on your software.

Abhi AryaCo-founder, Opennote

A lot of students tell us that the moment their connected tools start talking to each other inside Opennote feels almost magical. The agent just knows them, and it has immensely helped in keeping new users on the platform.

Nirman DaveCEO, Zams

We chose Composio over Pipedream because it delivered depth where it mattered. It supported niche tools and tricky edge cases that other platforms simply ignored. Giving us confidence to scale without compromising.

Ryan YuFounder, Extra Thursday

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down in the complexities of managing agent auth would have been a death sentence for Extra Thursday.

Tomisin JenrolaFounder & CEO, SwarmZero

Before partnering with Composio, adding tool integrations was a slow, resource-intensive process. Each integration could take weeks or months of engineering time, and maintaining them meant constantly keeping up with API changes.

Jerome LeclancheCo-Founder, Ingram Technologies

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

How to integrate Ngrok MCP with OpenAI Agents SDK

Table of Contents

Connect Ngrok without Auth hassles

Introduction

Also integrate Ngrok with

TL;DR

What is OpenAI Agents SDK?

What is the Ngrok MCP server, and what's possible with it?

Supported Tools & Triggers

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

What is Composio SDK?

How the Composio SDK works

Step-by-step Guide

Prerequisites

Getting API Keys for OpenAI and Composio

Install dependencies

Set up environment variables

Import dependencies

Set up the Composio instance

Create a Tool Router session

Configure the agent

Start chat loop and handle conversation

Complete Code

Conclusion

How to build Ngrok MCP Agent with another framework

Claude Agent SDK

Claude Code

Claude Cowork

Codex

OpenClaw

Hermes

CLI

Google ADK

LangChain

Vercel AI SDK

Mastra AI

LlamaIndex

CrewAI

Explore Other Toolkits

Supabase

Codeinterpreter

GitHub

FAQ

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

Can I use Tool Router MCP with OpenAI Agents SDK?

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

How safe is my data with Composio Tool Router?

Used by agents from

Never worry about agent reliability