How to integrate Faraday MCP with LlamaIndex

GET STARTED FOR FREE
Framework Integration Gradient
Faraday Logo
LlamaIndex Logo
divider

Introduction

This guide walks you through connecting Faraday to LlamaIndex using the Composio tool router. By the end, you'll have a working Faraday agent that can enrich salesforce leads with predictive insights, automate email categorization using faraday ai, trigger customer follow-up based on faraday scores through natural language commands.

This guide will help you understand how to give your LlamaIndex agent real control over a Faraday account through Composio's Faraday 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:
  • Set your OpenAI and Composio API keys
  • Install LlamaIndex and Composio packages
  • Create a Composio Tool Router session for Faraday
  • Connect LlamaIndex to the Faraday MCP server
  • Build a Faraday-powered agent using LlamaIndex
  • Interact with Faraday 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 Faraday MCP server, and what's possible with it?

The Faraday MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Faraday account. It provides structured and secure access so your agent can perform Faraday operations on your behalf.

Supported Tools & Triggers

Tools
Archive CohortTool to archive a cohort in Faraday.
Archive ConnectionTool to archive a connection in Faraday.
Archive DatasetTool to archive a dataset in Faraday.
Archive OutcomeTool to archive an outcome in Faraday.
Archive Persona SetTool to archive a persona set in Faraday.
Archive PlaceTool to archive a place in Faraday.
Archive ScopeTool to archive a scope in Faraday.
Archive StreamTool to archive a stream in Faraday.
Archive TargetTool to archive a target in Faraday.
Archive TraitTool to archive a trait in Faraday.
Create AccountTool to create a new Faraday account with specified name and branding.
Create CohortsTool to create a new cohort in Faraday.
Create DatasetTool to create a new dataset in Faraday.
Create OutcomeTool to create a new outcome.
Create Persona SetTool to create a new persona set.
Create PlaceTool to create a new place in Faraday.
Create ScopeTool to create a new scope in Faraday.
Create StreamTool to create a new stream or find an existing stream by name.
Create Target PreviewTool to start a preview delivery for a target.
Create TargetTool to create a target in Faraday.
Create TraitTool to create a new trait in Faraday.
Create Webhook EndpointTool to create a new webhook endpoint.
Delete AccountTool to delete an account by its UUID.
Delete All Orphaned TraitsTool to delete all orphaned traits from Faraday.
Delete CohortTool to permanently delete a cohort from Faraday.
Delete ConnectionTool to delete a Faraday connection by its UUID.
Delete DatasetTool to delete a dataset from Faraday.
Delete OutcomeTool to delete an outcome by its UUID.
Delete Persona SetTool to delete a persona set.
Delete PlaceTool to delete a place by its UUID.
Delete ScopeTool to delete a scope by its UUID.
Delete StreamTool to delete a stream by its UUID or name.
Delete TargetTool to delete a target by its UUID.
Delete UploadPermanently deletes a file from a Faraday dataset directory.
Delete Webhook EndpointTool to delete a webhook endpoint by its UUID.
Force Update CohortTool to trigger a rerun for a cohort.
Force Update ConnectionTool to trigger a rerun for a Faraday connection.
Force Update DatasetTool to trigger a rerun for a dataset.
Force Update OutcomeTool to trigger a rerun for an outcome resource.
Force Update Persona SetTool to trigger a rerun for a persona set resource.
Force Update PlaceTool to trigger a rerun for a place.
Force Update ScopeTool to trigger a rerun for a scope resource.
Force Update StreamTool to trigger a rerun for a stream.
Force Update TargetTool to trigger a rerun for a target.
Force Update TraitTool to trigger a rerun for a trait.
Get AccountTool to retrieve detailed information about a Faraday account by its UUID.
List AccountsTool to list all Faraday accounts accessible by the current user.
Get Accounts BillingTool to get billing information about your account.
Get CohortTool to retrieve a specific cohort by ID.
Get Cohort Membership AnalysisTool to get cohort membership counts over time for a specific cohort.
List CohortsTool to list all cohorts in your Faraday account.
Get Connection DatasetsTool to retrieve all datasets that use a specific connection.
Get Connection TargetsTool to retrieve all targets that use a specific connection.
Get Current AccountTool to retrieve the current account information.
Get Current Account BillingTool to retrieve billing information about the current account.
Get DatasetTool to retrieve a dataset by its UUID.
Get Dataset Ingress LogsTool to retrieve dataset ingress metrics over time.
List Feature StoresTool to list all feature stores.
Get Dependency GraphTool to retrieve the complete dependency graph for all resources on an account.
Get Market Opportunity AnalysesTool to retrieve all market opportunity analyses from Faraday.
Get OutcomeTool to retrieve an outcome by its ID.
List OutcomesTool to list all outcomes for the account.
Get Persona SetTool to retrieve a persona set by its UUID.
Get Persona Set Analysis FlowTool to retrieve the flow of persona sets over time, showing how individuals move between different personas.
List Persona SetsTool to list all persona sets.
Get Persona Set Analysis DimensionsTool to get various trait breakdown information about a persona set.
Get PlaceTool to retrieve a specific place by its UUID.
List PlacesTool to list all places in Faraday.
List RecommendersTool to list all recommenders.
Get ScopeTool to retrieve detailed information about a Faraday scope by its UUID.
Get Scope AnalysisTool to get analysis for a scope including outcomes and recommenders with probability distributions.
Get Scope DatasetsTool to retrieve all datasets associated with a Faraday scope.
Get Scope EfficacyTool to retrieve efficacy metrics for a scope.
Get Scope Payload CohortsTool to get payload cohorts for a specific scope.
Get Scope Payload OutcomesTool to retrieve payload outcomes for a specific scope.
Get Scope Payload Persona SetsTool to get payload persona sets for a specific scope.
Get Scope Payload RecommendersTool to retrieve payload recommenders for a specific scope.
Get Scope Population Exclusion CohortsTool to get population exclusion cohorts for a scope.
Get Scope Population CohortsTool to get population cohorts for a specific scope.
Get Scope TargetsTool to get all targets for a specific scope.
Get StreamTool to retrieve a stream by its UUID or name.
List StreamsTool to list all streams in your Faraday account.
Get Streams AnalysisTool to get the count of stream events emitted over a time period.
Get TargetTool to retrieve a specific target by its UUID from Faraday.
Get Target AnalysisTool to retrieve a target's analysis including geographic distributions and trait breakdowns.
Get TraitTool to retrieve a specific trait by ID.
Get Trait Analysis DimensionsTool to retrieve the percentage of the US population that falls into each category of a trait.
Get Traits CSVTool to retrieve all user-defined and Faraday-provided traits in CSV format.
Get UploadTool to download a previously uploaded file from a Faraday dataset directory.
List Uploaded FilesTool to retrieve the list of previously uploaded files in Faraday.
Get UsagesTool to retrieve usage statistics for your Faraday account.
Get Webhook EndpointTool to retrieve a webhook endpoint by its UUID.
List Webhook EndpointsTool to list all webhook endpoints configured for the account.
List AttributesTool to list all attributes in the feature store.
List ConnectionsTool to list all connections configured in Faraday.
List ScopesTool to list all scopes.
List TargetsTool to list all targets in your Faraday account.
Unarchive CohortTool to unarchive a previously archived cohort.
Unarchive DatasetTool to unarchive a dataset in Faraday.
Unarchive OutcomeTool to unarchive an outcome in Faraday.
Unarchive Persona SetTool to unarchive a previously archived persona set.
Unarchive PlaceTool to unarchive a previously archived place.
Unarchive ScopeTool to unarchive a previously archived scope.
Unarchive StreamTool to unarchive a stream in Faraday.
Unarchive TraitTool to unarchive a trait.
Update AccountTool to update an account's name or branding settings.
Update CohortTool to update a cohort's configuration using JSON Merge Patch semantics.
Update ConnectionTool to update a Faraday connection's name or options.
Update DatasetTool to update a dataset configuration using JSON Merge Patch semantics.
Update OutcomeTool to update an outcome's configuration using JSON Merge Patch semantics.
Update Persona SetTool to edit a persona set's configuration using JSON Merge Patch.
Update PlaceTool to update a place's name, addresses, or geojson geometry.
Update ScopeTool to update a Faraday scope's configuration using JSON Merge Patch semantics.
Update StreamTool to update a stream's properties using JSON Merge Patch semantics.
Update TargetTool to update a target's configuration in Faraday.
Update TraitTool to update a trait's properties using JSON Merge Patch semantics.
Update Webhook EndpointTool to update a webhook endpoint's configuration.

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 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 Faraday account and project
  • Basic familiarity with async Python/Typescript

Getting API Keys for OpenAI, Composio, and Faraday

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

Installing dependencies

pip install composio-llamaindex llama-index llama-index-llms-openai llama-index-tools-mcp python-dotenv

Create a new Python project and install the necessary dependencies:

  • composio-llamaindex: Composio's LlamaIndex integration
  • llama-index: Core LlamaIndex framework
  • llama-index-llms-openai: OpenAI LLM integration
  • llama-index-tools-mcp: MCP client for LlamaIndex
  • python-dotenv: Environment variable management

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 Faraday access

Import modules

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()

Create a new file called faraday_llamaindex_agent.py and import the required modules:

Key imports:

  • asyncio: For async/await support
  • Composio: Main client for Composio services
  • LlamaIndexProvider: Adapts Composio tools for LlamaIndex
  • ReActAgent: LlamaIndex's reasoning and action agent
  • BasicMCPClient: Connects to MCP endpoints
  • McpToolSpec: Converts MCP tools to LlamaIndex format

Load environment variables and initialize Composio

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")

What's happening:

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

Create a Tool Router session and build the agent function

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=["faraday"],
    )

    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 Faraday actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform Faraday actions.
    """
    return ReActAgent(tools=tools, llm=llm, description=description, system_prompt=system_prompt, verbose=True)

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, faraday)
  • 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 Faraday tools.
  • The MCP tools are mapped to LlamaIndex-compatible tools and plug them into the Agent.

Create an interactive chat loop

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}")

What's happening here:

  • We're creating a direct terminal interface to chat with your Faraday database
  • The LLM's responses are streamed to the CLI for faster interaction.
  • The agent uses context to maintain conversation history
  • You can type 'quit' or 'exit' to stop the chat loop gracefully
  • Agent responses and any errors are displayed in a clear, readable format

Define the main entry point

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!")

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 Faraday

Run the agent

npx ts-node llamaindex-agent.ts

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

Complete Code

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

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=["faraday"],
    )

    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 Faraday actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform Faraday 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!")

Conclusion

You've successfully connected Faraday to LlamaIndex through Composio's Tool Router MCP layer. Key takeaways:
  • Tool Router dynamically exposes Faraday 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 Faraday MCP Agent with another framework

OpenAI Agents SDK

OpenAI Agents SDK

Use Faraday MCP with OpenAI Agents SDK

Claude Agent SDK

Claude Agent SDK

Use Faraday MCP with Claude Agent SDK

Google ADK

Google ADK

Use Faraday MCP with Google ADK

LangChain

LangChain

Use Faraday MCP with LangChain

Vercel AI SDK

Vercel AI SDK

Use Faraday MCP with Vercel AI SDK

Mastra AI

Mastra AI

Use Faraday MCP with Mastra AI

CrewAI

CrewAI

Use Faraday MCP with CrewAI

Claude Code

Claude Code

Use Faraday MCP with Claude Code

Codex

Codex

Use Faraday MCP with Codex

FAQ

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

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

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

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