# How to integrate Payhere MCP with CrewAI ```json { "title": "How to integrate Payhere MCP with CrewAI", "toolkit": "Payhere", "toolkit_slug": "payhere", "framework": "CrewAI", "framework_slug": "crew-ai", "url": "https://composio.dev/toolkits/payhere/framework/crew-ai", "markdown_url": "https://composio.dev/toolkits/payhere/framework/crew-ai.md", "updated_at": "2026-03-29T06:44:58.701Z" } ``` ## Introduction This guide walks you through connecting Payhere to CrewAI using the Composio tool router. By the end, you'll have a working Payhere agent that can create a payment link for $50 consultation, list all completed payments this week, send a payment reminder to john doe through natural language commands. This guide will help you understand how to give your CrewAI agent real control over a Payhere account through Composio's Payhere MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Payhere with - [OpenAI Agents SDK](https://composio.dev/toolkits/payhere/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/payhere/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/payhere/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/payhere/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/payhere/framework/codex) - [OpenClaw](https://composio.dev/toolkits/payhere/framework/openclaw) - [Hermes](https://composio.dev/toolkits/payhere/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/payhere/framework/cli) - [Google ADK](https://composio.dev/toolkits/payhere/framework/google-adk) - [LangChain](https://composio.dev/toolkits/payhere/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/payhere/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/payhere/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/payhere/framework/llama-index) ## TL;DR Here's what you'll learn: - Get a Composio API key and configure your Payhere connection - Set up CrewAI with an MCP enabled agent - Create a Tool Router session or standalone MCP server for Payhere - Build a conversational loop where your agent can execute Payhere operations ## What is CrewAI? CrewAI is a powerful framework for building multi-agent AI systems. It provides primitives for defining agents with specific roles, creating tasks, and orchestrating workflows through crews. Key features include: - Agent Roles: Define specialized agents with specific goals and backstories - Task Management: Create tasks with clear descriptions and expected outputs - Crew Orchestration: Combine agents and tasks into collaborative workflows - MCP Integration: Connect to external tools through Model Context Protocol ## What is the Payhere MCP server, and what's possible with it? The Payhere MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Payhere account. It provides structured and secure access so your agent can perform Payhere operations on your behalf. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `PAYHERE_CREATE_HOOK` | Create Hook | Tool to subscribe to a REST hook for receiving webhook events. Use when you need to register a webhook endpoint to receive real-time notifications for payment_received, subscription_cancelled, or subscription_created events. | | `PAYHERE_CREATE_PLAN` | Create Plan | Tool to create a new payment plan in PayHere. Use when you need to set up either a recurring subscription or one-off payment plan for accepting payments. | | `PAYHERE_DELETE_HOOK` | Delete Hook | Tool to remove a REST hook listener subscription. Use when you need to stop receiving webhook events for a specific hook. | | `PAYHERE_GET_CURRENT_COMPANY` | Get Current Company | Tool to fetch company information for the currently authenticated user. Use when you need to retrieve comprehensive company details including identity, configuration, integration status, and associated users. | | `PAYHERE_GET_CURRENT_COMPANY_STATS` | Get Current Company Stats | Tool to fetch payment statistics for the last 30 days with comparison data from the preceding 30-day period (30-60 days ago). Use when you need to analyze recent payment trends, subscriber growth, or compare current performance against the previous month. | | `PAYHERE_GET_USER` | Get User | Tool to fetch information on the currently authenticated user. Use when you need to retrieve details about the logged-in user. | | `PAYHERE_LIST_CUSTOMERS` | List Customers | Tool to list all customers from Payhere, ordered chronologically with most recent first. Use when you need to retrieve customer records, browse customers, or access customer information. Supports pagination via page and per_page parameters. | | `PAYHERE_LIST_REST_HOOKS` | List REST Hooks | Tool to list all active REST hooks subscriptions for the authenticated company. Use when you need to view all currently registered webhook listeners for your PayHere account. | | `PAYHERE_LIST_PAYMENTS` | List Payments | Tool to list all payments ordered chronologically, most recent first. Use when you need to retrieve payment history or check payment statuses. Supports pagination with page and per_page parameters. | | `PAYHERE_LIST_PLANS` | List Plans | Tool to list all plans in your PayHere account. Use when you need to retrieve and paginate through available plans. | | `PAYHERE_LIST_SUBSCRIPTIONS` | List subscriptions | Tool to list all subscriptions ordered chronologically by most recent payment first. Use when you need to retrieve subscription data with customer and plan details. | | `PAYHERE_UPDATE_CURRENT_COMPANY` | Update Current Company | Tool to update the company information for the currently authenticated user. Use when modifying company details such as name, legal name, address, logo, support email, website, or branding preferences (button color and text color). | | `PAYHERE_UPDATE_PLAN` | Update Plan | Tool to update an existing plan's configuration and settings. Use when you need to modify plan properties like name, description, pricing, or other settings for both one-off and subscription plans. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Payhere MCP server is an implementation of the Model Context Protocol that connects your AI agent to Payhere. It provides structured and secure access so your agent can perform Payhere operations on your behalf through a secure, permission-based interface. With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster. ## Step-by-step Guide ### 1. Prerequisites Before starting, make sure you have: - Python 3.9 or higher - A Composio account and API key - A Payhere connection authorized in Composio - An OpenAI API key for the CrewAI LLM - Basic familiarity with Python ### 1. Getting API Keys for OpenAI and Composio OpenAI API Key - Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) 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](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs). - Navigate to your API settings and generate a new API key. - Store this key securely as you'll need it for authentication. ### 2. Install dependencies **What's happening:** - composio connects your agent to Payhere via MCP - crewai provides Agent, Task, Crew, and LLM primitives - crewai-tools[mcp] includes MCP helpers - python-dotenv loads environment variables from .env ```bash pip install composio crewai crewai-tools[mcp] python-dotenv ``` ### 3. Set up environment variables Create a .env file in your project root. What's happening: - COMPOSIO_API_KEY authenticates with Composio - USER_ID scopes the session to your account - OPENAI_API_KEY lets CrewAI use your chosen OpenAI model ```bash COMPOSIO_API_KEY=your_composio_api_key_here USER_ID=your_user_id_here OPENAI_API_KEY=your_openai_api_key_here ``` ### 4. Import dependencies **What's happening:** - CrewAI classes define agents and tasks, and run the workflow - MCPServerHTTP connects the agent to an MCP endpoint - Composio will give you a short lived Payhere MCP URL ```python import os from composio import Composio from crewai import Agent, Task, Crew from crewai_tools import MCPServerAdapter import dotenv dotenv.load_dotenv() COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY") COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID") 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") ``` ### 5. Create a Composio Tool Router session for Payhere **What's happening:** - You create a Payhere only session through Composio - Composio returns an MCP HTTP URL that exposes Payhere tools ```python composio_client = Composio(api_key=COMPOSIO_API_KEY) session = composio_client.create(user_id=COMPOSIO_USER_ID, toolkits=["payhere"]) url = session.mcp.url ``` ### 6. Initialize the MCP Server **What's Happening:** - Server Configuration: The code sets up connection parameters including the MCP server URL, streamable HTTP transport, and Composio API key authentication. - MCP Adapter Bridge: MCPServerAdapter acts as a context manager that converts Composio MCP tools into a CrewAI-compatible format. - Agent Setup: Creates a CrewAI Agent with a defined role (Search Assistant), goal (help with internet searches), and access to the MCP tools. - Configuration Options: The agent includes settings like verbose=False for clean output and max_iter=10 to prevent infinite loops. - Dynamic Tool Usage: Once created, the agent automatically accesses all Composio Search tools and decides when to use them based on user queries. ```python server_params = { "url": url, "transport": "streamable-http", "headers": {"x-api-key": COMPOSIO_API_KEY}, } with MCPServerAdapter(server_params) as tools: agent = Agent( role="Search Assistant", goal="Help users search the internet effectively", backstory="You are a helpful assistant with access to search tools.", tools=tools, verbose=False, max_iter=10, ) ``` ### 7. Create a CLI Chatloop and define the Crew **What's Happening:** - Interactive CLI Setup: The code creates an infinite loop that continuously prompts for user input and maintains the entire conversation history in a string variable. - Input Validation: Empty inputs are ignored to prevent processing blank messages and keep the conversation clean. - Context Building: Each user message is appended to the conversation context, which preserves the full dialogue history for better agent responses. - Dynamic Task Creation: For every user input, a new Task is created that includes both the full conversation history and the current request as context. - Crew Execution: A Crew is instantiated with the agent and task, then kicked off to process the request and generate a response. - Response Management: The agent's response is converted to a string, added to the conversation context, and displayed to the user, maintaining conversational continuity. ```python print("Chat started! Type 'exit' or 'quit' to end.\n") conversation_context = "" while True: user_input = input("You: ").strip() if user_input.lower() in ["exit", "quit", "bye"]: print("\nGoodbye!") break if not user_input: continue conversation_context += f"\nUser: {user_input}\n" print("\nAgent is thinking...\n") task = Task( description=( f"Conversation history:\n{conversation_context}\n\n" f"Current request: {user_input}" ), expected_output="A helpful response addressing the user's request", agent=agent, ) crew = Crew(agents=[agent], tasks=[task], verbose=False) result = crew.kickoff() response = str(result) conversation_context += f"Agent: {response}\n" print(f"Agent: {response}\n") ``` ## Complete Code ```python from crewai import Agent, Task, Crew, LLM from crewai_tools import MCPServerAdapter from composio import Composio from dotenv import load_dotenv import os load_dotenv() GOOGLE_API_KEY = os.getenv("GOOGLE_API_KEY") COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY") COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID") if not GOOGLE_API_KEY: raise ValueError("GOOGLE_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.") # Initialize Composio and create a session composio = Composio(api_key=COMPOSIO_API_KEY) session = composio.create( user_id=COMPOSIO_USER_ID, toolkits=["payhere"], ) url = session.mcp.url # Configure LLM llm = LLM( model="gpt-5", api_key=os.getenv("OPENAI_API_KEY"), ) server_params = { "url": url, "transport": "streamable-http", "headers": {"x-api-key": COMPOSIO_API_KEY}, } with MCPServerAdapter(server_params) as tools: agent = Agent( role="Search Assistant", goal="Help users with internet searches", backstory="You are an expert assistant with access to Composio Search tools.", tools=tools, llm=llm, verbose=False, max_iter=10, ) print("Chat started! Type 'exit' or 'quit' to end.\n") conversation_context = "" while True: user_input = input("You: ").strip() if user_input.lower() in ["exit", "quit", "bye"]: print("\nGoodbye!") break if not user_input: continue conversation_context += f"\nUser: {user_input}\n" print("\nAgent is thinking...\n") task = Task( description=( f"Conversation history:\n{conversation_context}\n\n" f"Current request: {user_input}" ), expected_output="A helpful response addressing the user's request", agent=agent, ) crew = Crew(agents=[agent], tasks=[task], verbose=False) result = crew.kickoff() response = str(result) conversation_context += f"Agent: {response}\n" print(f"Agent: {response}\n") ``` ## Conclusion You now have a CrewAI agent connected to Payhere through Composio's Tool Router. The agent can perform Payhere operations through natural language commands. Next steps: - Add role-specific instructions to customize agent behavior - Plug in more toolkits for multi-app workflows - Chain tasks for complex multi-step operations ## How to build Payhere MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/payhere/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/payhere/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/payhere/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/payhere/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/payhere/framework/codex) - [OpenClaw](https://composio.dev/toolkits/payhere/framework/openclaw) - [Hermes](https://composio.dev/toolkits/payhere/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/payhere/framework/cli) - [Google ADK](https://composio.dev/toolkits/payhere/framework/google-adk) - [LangChain](https://composio.dev/toolkits/payhere/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/payhere/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/payhere/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/payhere/framework/llama-index) ## Related Toolkits - [Stripe](https://composio.dev/toolkits/stripe) - Stripe is a global online payments platform offering APIs for managing payments, customers, and subscriptions. Trusted by businesses for secure, efficient, and scalable payment processing worldwide. - [Alpha vantage](https://composio.dev/toolkits/alpha_vantage) - Alpha Vantage is a financial data platform offering real-time and historical stock market APIs. Get instant, reliable access to equities, forex, and technical analysis data for smarter trading decisions. - [Altoviz](https://composio.dev/toolkits/altoviz) - Altoviz is a cloud-based billing and invoicing platform for businesses. It streamlines online payments, expense tracking, and customizable invoice management. - [Benzinga](https://composio.dev/toolkits/benzinga) - Benzinga provides real-time financial news and data APIs for market coverage. It helps you track breaking news and actionable market insights instantly. - [Brex](https://composio.dev/toolkits/brex) - Brex provides corporate credit cards and spend management tailored for startups and tech businesses. It helps optimize company cash flow, streamline accounting, and accelerate business growth. - [Chaser](https://composio.dev/toolkits/chaser) - Chaser is accounts receivable automation software that sends invoice reminders and helps businesses get paid faster. It streamlines the collections process to save time and improve cash flow. - [Clientary](https://composio.dev/toolkits/clientary) - Clientary is a platform for managing clients, invoices, projects, proposals, and more. It streamlines client work and saves you serious admin time. - [Coinbase](https://composio.dev/toolkits/coinbase) - Coinbase is a platform for buying, selling, and storing cryptocurrency. It makes exchanging and managing crypto simple and secure for everyone. - [Coinranking](https://composio.dev/toolkits/coinranking) - Coinranking is a comprehensive cryptocurrency market data platform offering access to real-time coin prices, market caps, and historical data. Get accurate, up-to-date stats for thousands of digital assets in one place. - [Coupa](https://composio.dev/toolkits/coupa) - Coupa is a business spend management platform for procurement, invoicing, and expenses. It helps organizations streamline purchasing, control costs, and gain complete visibility over financial operations. - [CurrencyScoop](https://composio.dev/toolkits/currencyscoop) - CurrencyScoop is a developer-friendly API for real-time and historical currency exchange rates. Easily access fiat and crypto data for smart, up-to-date financial applications. - [Daffy](https://composio.dev/toolkits/daffy) - Daffy is a modern charitable giving platform with a donor-advised fund. Easily set aside funds, grow them tax-free, and donate to over 1.7 million U.S. charities. - [Eagle doc](https://composio.dev/toolkits/eagle_doc) - Eagle doc is an AI-powered OCR API for invoices and receipts. It delivers fast, reliable, and accurate document data extraction for seamless automation. - [Elorus](https://composio.dev/toolkits/elorus) - Elorus is an online invoicing and time-tracking software for freelancers and small businesses. Easily manage finances, bill clients, and track work in one place. - [Eodhd apis](https://composio.dev/toolkits/eodhd_apis) - Eodhd apis delivers comprehensive financial data, including live and historical stock prices, via robust APIs. Easily access reliable, up-to-date market insights to power your apps, dashboards, and analytics. - [Fidel api](https://composio.dev/toolkits/fidel_api) - Fidel api is a secure platform for linking payment cards to web and mobile apps. It enables real-time card transaction monitoring and event-based automation for businesses. - [Finage](https://composio.dev/toolkits/finage) - Finage is a secure API platform delivering real-time and historical financial data for stocks, forex, crypto, indices, and commodities. It empowers developers and businesses to access, analyze, and act on market data instantly. - [Finmei](https://composio.dev/toolkits/finmei) - Finmei is an invoicing tool that simplifies billing, invoice management, and expense tracking. Ideal for automating and organizing your business finances in one place. - [Fixer](https://composio.dev/toolkits/fixer) - Fixer is a currency data API offering real-time and historical exchange rates for 170 currencies. Instantly access accurate, up-to-date forex data for your applications and workflows. - [Fixer io](https://composio.dev/toolkits/fixer_io) - Fixer.io is a lightweight API for real-time and historical foreign exchange rates. It makes global currency conversion fast, accurate, and hassle-free. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Payhere MCP? With a standalone Payhere MCP server, the agents and LLMs can only access a fixed set of Payhere tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Payhere and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with CrewAI? Yes, you can. CrewAI 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 Payhere tools. ### Can I manage the permissions and scopes for Payhere while using Tool Router? Yes, absolutely. You can configure which Payhere 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 Payhere data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) ยท [Composio docs](https://docs.composio.dev/llms.txt)