How to integrate Ngrok MCP with LlamaIndex

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

Ngrok logoNgrok
Api Key

Ngrok is a tunneling service that exposes your local applications to the internet securely. It lets developers share, test, and receive webhooks without dealing with complex network configuration.

102 Tools

Introduction

This guide walks you through connecting Ngrok to LlamaIndex 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 LlamaIndex 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:
  • Set your OpenAI and Composio API keys
  • Install LlamaIndex and Composio packages
  • Create a Composio Tool Router session for Ngrok
  • Connect LlamaIndex to the Ngrok MCP server
  • Build a Ngrok-powered agent using LlamaIndex
  • Interact with Ngrok 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 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.

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

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

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

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

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

Step-by-step Guide

Step by step10 STEPS
1

Prerequisites

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

Getting API Keys for OpenAI, Composio, and Ngrok

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

Installing dependencies

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

Create a new Typescript project and install the necessary dependencies:

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

Set environment variables

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

Create a .env file in your project root:

These credentials will be used to:

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

Import modules

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

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

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

dotenv.config();

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

Key imports:

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

Load environment variables and initialize Composio

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

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

What's happening:

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

7

Create a Tool Router session and build the agent function

async function buildAgent() {

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

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

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

  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 Ngrok actions." ,
    llm,
    tools,
  });

  return agent;
}

What's happening here:

  • We create a Composio client using your API key and configure it with the LlamaIndex provider
  • We then create a tool router MCP session for your user, specifying the toolkits we want to use (in this case, ngrok)
  • 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 Ngrok tools.
  • The MCP tools are mapped to LlamaIndex-compatible tools and plug them into the Agent.
8

Create an interactive chat loop

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

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

  while (true) {
    let userInput: string;

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

    if (!userInput) {
      continue;
    }

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

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

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

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

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

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

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

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

  rl.close();
}

What's happening:

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

Define the main entry point

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

main();

What's happening here:

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

Run the agent

npx ts-node llamaindex-agent.ts

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

Complete Code

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

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

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

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

dotenv.config();

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

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

async function buildAgent() {

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

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

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

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

Supported Tools

Every Ngrok action and event your agent gets out of the box.

Create API Key

Creates a new API key for authenticating with the ngrok API.

Create Tunnel Credential

Creates a new tunnel authtoken credential for authenticating ngrok agents.

Create Endpoint

Create a cloud endpoint on the ngrok account.

Create Event Source

Add a new event source to an event subscription.

Create Event Subscription

Creates a new event subscription in ngrok.

Create HTTPS Edge

Creates a new HTTPS edge in your ngrok account.

Create HTTPS Edge Route

Creates a new route on an HTTPS edge in ngrok.

Create SSH Credential

Creates a new SSH credential from an uploaded public SSH key.

Create Vault

Creates a new vault in your ngrok account.

Create Vault Secret

Tool to create a new secret in an ngrok vault for secure storage of sensitive data like API keys, passwords, or tokens.

Delete API Key

Delete an API key by its ID.

Delete Credentials

Delete a tunnel authtoken credential by ID.

Delete HTTPS Edge Route Circuit Breaker Module

Delete the Circuit Breaker module from an HTTPS Edge Route.

Delete Edge Route Compression Module

Delete the compression module from an HTTPS edge route.

Delete Edge Route Request Headers Module

Delete the request headers module from an HTTPS edge route.

Delete Edge Route Response Headers Module

Delete the response headers module from an HTTPS edge route.

Delete Edge Route SAML Module

Delete the SAML module configuration from an HTTPS edge route.

Delete Edge Route User Agent Filter Module

Delete the user agent filter module from an HTTPS edge route.

Delete Edge Route Webhook Verification Module

Delete the webhook verification module from an HTTPS edge route.

Delete Edge Route WebSocket TCP Converter Module

Delete the WebSocket TCP converter module from an HTTPS edge route.

Delete Endpoint

Delete an endpoint by ID.

Delete Event Source

Delete an event source from an event subscription.

Delete Event Subscription

Delete an event subscription by ID.

Delete HTTPS Edge

Delete an HTTPS edge by ID.

Delete HTTPS Edge Route

Delete an HTTPS edge route by ID.

Delete Reserved Domain Certificate

Detach the certificate attached to a reserved domain.

Delete Reserved Domain Certificate Management Policy

Detach the certificate management policy from a reserved domain.

Delete Secret

Delete a vault secret by ID.

Delete SSH Credentials

Delete an SSH credential by ID.

Delete Vault

Delete a vault by ID.

Get API Key

Get the details of an API key by ID.

Get Credentials

Tool to retrieve detailed information about a tunnel authtoken credential by ID.

Get Edge Route Backend Module

Retrieves the backend module configuration for an HTTPS edge route.

Get Edge Route Circuit Breaker Module

Tool to retrieve the circuit breaker module configuration for a specific HTTPS edge route.

Get Edge Route Compression Module

Retrieves the compression module configuration for a specific HTTPS edge route.

Get Edge Route IP Restriction Module

Retrieves the IP restriction module configuration for a specific HTTPS edge route.

Get Edge Route OIDC Module

Retrieves the OIDC (OpenID Connect) module configuration for a specific HTTPS edge route.

Get Edge Route Request Headers Module

Retrieves the request headers module configuration for a specific HTTPS edge route.

Get Edge Route Response Headers Module

Get the response headers module configuration for an HTTPS edge route.

Get Edge Route SAML Module

Retrieves the SAML authentication module configuration for a specific HTTPS edge route.

Get Edge Route Traffic Policy

Retrieves the Traffic Policy module configuration for a specific HTTPS edge route.

Get Edge Route User Agent Filter Module

Retrieves the user agent filter module configuration for a specific HTTPS edge route.

Get Edge Route Webhook Verification Module

Retrieves the webhook verification module configuration for an HTTPS edge route.

Get Edge Route WebSocket TCP Converter Module

Retrieves the WebSocket TCP Converter module configuration for a specific HTTPS edge route.

Get Endpoint

Get the status of an endpoint by ID.

Get Event Source

Get an event source by type for a specific event subscription.

Get HTTPS Edge

Get the details of an HTTPS edge by ID.

Get HTTPS Edge Mutual TLS Module

Retrieves the mutual TLS module configuration for an HTTPS edge.

Get HTTPS Edge Route

Retrieves detailed information about a specific HTTPS edge route by its ID.

Get IP Restriction Details

Retrieves detailed information about a specific IP restriction by its ID.

Get Reserved Domain

Get the details of a reserved domain by ID.

Get Secret

Tool to retrieve detailed information about a vault secret by ID.

Get Secrets by Vault

Tool to get all secrets in a vault by vault ID.

Get SSH Credentials

Tool to retrieve detailed information about an SSH credential by ID.

Get Vault

Get the details of a vault by ID.

List Agent Ingresses

List all Agent Ingresses owned by this account.

List API Keys

This tool lists all API keys owned by the user.

List Bot Users

Tool to list all bot users on this ngrok account.

List Certificate Authorities

List all certificate authorities on this account.

List Tunnel Credentials

List all tunnel authtoken credentials on the ngrok account.

List All Endpoints

List all active endpoints on the ngrok account.

List Event Destinations

List all Event Destinations on the ngrok account.

List Event Subscriptions

List all event subscriptions on the ngrok account.

List Event Subscription Sources

Tool to list the types for which this event subscription will trigger.

List Failover Backends

List all failover backends on this account.

List HTTP Response Backends

List all HTTP response backends on the account.

List HTTPS Edges

Lists all HTTPS Edges in your ngrok account.

List IP Policies

List all IP policies on this account.

List IP Policy Rules

This tool lists all IP policy rules associated with your ngrok account.

List IP Restrictions

Lists all IP restrictions configured on the ngrok account.

List Reserved Addresses

List all reserved addresses on this account.

List Reserved Domains

List all reserved domains on this account.

List Service Users

Tool to list all service users on this ngrok account.

List SSH Certificate Authorities

List all SSH Certificate Authorities on this account.

List SSH Credentials

List all SSH credentials on the ngrok account.

List SSH Host Certificates

List all SSH Host Certificates issued on this account.

List SSH User Certificates

List all SSH user certificates on the ngrok account.

List Static Backends

List all static backends on the account.

List TCP Edges

Lists all TCP Edges in your ngrok account.

List TLS Certificates

List all TLS certificates on the ngrok account.

List TLS Edges

Lists all TLS Edges in your ngrok account.

List Active Tunnels

List all active tunnels in the ngrok account.

List Tunnel Sessions

List all online tunnel sessions running on this account.

List Vaults

List all vaults owned by the ngrok account.

List Vault Secrets

List all vault secrets owned by the ngrok account.

List Weighted Backends

List all weighted backends on the ngrok account.

Replace Edge Route Circuit Breaker Module

Replaces the circuit breaker module configuration on an HTTPS edge route.

Replace Edge Route Compression Module

Replaces the compression module configuration for an HTTPS edge route.

Replace Edge Route Request Headers Module

Replaces the request headers module configuration for an HTTPS edge route.

Replace Edge Route Response Headers Module

Replaces the response headers module configuration for an HTTPS edge route.

Replace Edge Route Traffic Policy

Replaces the traffic policy module on an HTTPS edge route.

Replace Edge Route User Agent Filter Module

Replaces the user agent filter module configuration for an HTTPS edge route.

Replace Edge Route Webhook Verification Module

Replaces the webhook verification module configuration for an HTTPS edge route.

Update API Key

Updates attributes of an API key by ID.

Update Credentials

Tool to update attributes of a tunnel authtoken credential by ID.

Update Endpoint

Tool to update an Endpoint by ID, currently available only for cloud endpoints.

Update Event Subscription

Tool to update attributes of an event subscription by ID.

Update HTTPS Edge Route

Tool to update an HTTPS edge route by ID.

Update Reserved Domain

Tool to update the attributes of a reserved domain by ID.

Update Secret

Tool to update a vault secret by ID.

Update SSH Credential

Tool to update attributes of an SSH credential by ID.

Update Vault

Tool to update attributes of a vault by ID.

FAQ

Frequently asked questions

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.

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 Ngrok tools.

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.

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.

Start with Ngrok.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Ngrok tool your agent needs.Free to start.

Start building