# How to integrate Btcpay server MCP with Pydantic AI ```json { "title": "How to integrate Btcpay server MCP with Pydantic AI", "toolkit": "Btcpay server", "toolkit_slug": "btcpay_server", "framework": "Pydantic AI", "framework_slug": "pydantic-ai", "url": "https://composio.dev/toolkits/btcpay_server/framework/pydantic-ai", "markdown_url": "https://composio.dev/toolkits/btcpay_server/framework/pydantic-ai.md", "updated_at": "2026-05-12T10:04:21.597Z" } ``` ## Introduction This guide walks you through connecting Btcpay server to Pydantic AI using the Composio tool router. By the end, you'll have a working Btcpay server agent that can create a new bitcoin payment request for your store, list all payment requests for store abc123, register a webhook for payment notifications through natural language commands. This guide will help you understand how to give your Pydantic AI agent real control over a Btcpay server account through Composio's Btcpay server MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Btcpay server with - [OpenAI Agents SDK](https://composio.dev/toolkits/btcpay_server/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/btcpay_server/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/btcpay_server/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/btcpay_server/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/btcpay_server/framework/codex) - [OpenClaw](https://composio.dev/toolkits/btcpay_server/framework/openclaw) - [Hermes](https://composio.dev/toolkits/btcpay_server/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/btcpay_server/framework/cli) - [Google ADK](https://composio.dev/toolkits/btcpay_server/framework/google-adk) - [LangChain](https://composio.dev/toolkits/btcpay_server/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/btcpay_server/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/btcpay_server/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/btcpay_server/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/btcpay_server/framework/crew-ai) ## TL;DR Here's what you'll learn: - How to set up your Composio API key and User ID - How to create a Composio Tool Router session for Btcpay server - How to attach an MCP Server to a Pydantic AI agent - How to stream responses and maintain chat history - How to build a simple REPL-style chat interface to test your Btcpay server workflows ## What is Pydantic AI? Pydantic AI is a Python framework for building AI agents with strong typing and validation. It leverages Pydantic's data validation capabilities to create robust, type-safe AI applications. Key features include: - Type Safety: Built on Pydantic for automatic data validation - MCP Support: Native support for Model Context Protocol servers - Streaming: Built-in support for streaming responses - Async First: Designed for async/await patterns ## What is the Btcpay server MCP server, and what's possible with it? The Btcpay server MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Btcpay server account. It provides structured and secure access to your Bitcoin payment infrastructure, so your agent can perform actions like creating payment requests, managing stores, handling API keys, and automating webhooks on your behalf. - Automated payment request creation: Instruct your agent to generate new payment requests for your stores, making it simple to accept Bitcoin payments from customers without manual setup. - Store management and provisioning: Let your agent create, configure, or remove stores in your Btcpay server environment to support multiple business units or projects. - API key administration: Ask your agent to list, retrieve, or revoke API keys, streamlining secure access control for developers and integrations. - Webhook registration for event automation: Enable your agent to register webhooks, so you can receive instant notifications or trigger workflows when key payment or store events occur. - User and payout management: Have the agent create new server users programmatically or delete store payouts that are no longer needed, giving you granular control over your payment operations. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `BTCPAY_SERVER_CREATE_PAYMENT_REQUEST` | Create Payment Request | Creates a new payment request in a BTCPay Server store. Payment requests are shareable pages where customers can create invoices to pay the requested amount. Unlike direct invoices, payment requests can be reused and allow customers to initiate payments themselves. Use this after obtaining a valid store ID from the create_store or get_store actions. | | `BTCPAY_SERVER_CREATE_STORE` | Create Store | Tool to create a new store in BTCPay Server. Use when you need to provision a new store before processing transactions. | | `BTCPAY_SERVER_CREATE_USER` | Create BTCPay Server User | Tool to create a new BTCPay Server user. Use when you need to register a new user programmatically as an administrator. | | `BTCPAY_SERVER_CREATE_WEBHOOK` | Register a Webhook | Registers a new webhook for a BTCPay store to receive real-time notifications when store events occur (e.g., invoice created, payment received, invoice settled). The webhook endpoint receives POST requests with event payloads signed using an HMAC secret for verification. | | `BTCPAY_SERVER_DELETE_API_KEY` | Delete API Key | Revoke a specific API key to immediately prevent its use for authentication. Use this tool when you need to disable an API key, such as when rotating credentials or when a key may have been compromised. The revocation takes effect immediately. Note: This action requires authentication with an API key that has user management permissions. | | `BTCPAY_SERVER_DELETE_PAYMENT_REQUEST` | Delete Payment Request | Deletes (archives) a specific payment request from a BTCPay Server store. Use this tool when you need to remove or archive an existing payment request. The payment request will be marked as archived and will no longer be active. This operation requires the 'btcpay.store.canmodifypaymentrequests' API permission. Note: This is a destructive operation - once deleted, the payment request cannot be restored. | | `BTCPAY_SERVER_DELETE_PAYOUT` | Cancel Store Payout | Cancels (deletes) a specific payout from a BTCPay Server store. Use this tool when you need to cancel a pending payout that is no longer needed. Only payouts in 'AwaitingApproval' or 'AwaitingPayment' state can be canceled. Payouts that have already been processed or completed cannot be canceled. Requires the 'btcpay.store.canmanagepayouts' permission on the API key. | | `BTCPAY_SERVER_GET_API_KEYS` | Get Current API Key | Retrieve information about the current API key. Returns details including the API key string, its label, and the permissions it has been granted. Use this to verify authentication is working and to check what permissions the current API key has. Note: BTCPay Server only provides access to the current API key, not all API keys associated with the user account. This tool is read-only; it cannot create, modify, or delete API keys. | | `BTCPAY_SERVER_GET_PAYMENT_REQUESTS` | Get Payment Requests | Tool to list all payment requests for a specific store. Use after confirming you have the store ID. | | `BTCPAY_SERVER_GET_SERVER_INFO` | Get BTCPay Server Info | Tool to retrieve information about the BTCPay Server instance. Use when needing server version, tor address, supported payment methods, and synchronization states. | | `BTCPAY_SERVER_GET_STORE` | Get Store | Retrieves complete configuration and settings for a specific BTCPay Server store by its ID. Use this tool when you need to: - Get current store settings and configuration - Check store properties like payment methods, currency, invoice expiration, etc. - Verify store exists and is accessible - Retrieve branding/display settings (logo, colors, checkout page settings) Returns comprehensive store data including payment settings, checkout configuration, and branding. Results are scoped to the authenticated user's permissions; insufficient permissions may return restricted or empty data rather than an explicit error. | | `BTCPAY_SERVER_GET_USER` | Get BTCPay Server User | Retrieve information about a BTCPay Server user by ID or email. Use 'me' as the id_or_email parameter to get the currently authenticated user's profile. Alternatively, provide a specific user ID (UUID) or email address to retrieve another user's information. Requires API key with 'btcpay.user.canviewprofile' permission scope. Note: Viewing other users' profiles requires server administrator privileges. | | `BTCPAY_SERVER_GET_WEBHOOK` | Get Store Webhook | Retrieves detailed configuration of a specific webhook registered for a BTCPay store, including its callback URL, subscribed events, enabled status, and automatic redelivery settings. | | `BTCPAY_SERVER_GET_WEBHOOKS` | List Store Webhooks | Lists all webhooks registered for a BTCPay Server store. Use this to retrieve webhook configurations for management, auditing, or to find webhook IDs for update/delete operations. | | `BTCPAY_SERVER_LIST_APPS` | List Apps | Retrieve all apps (Point of Sale, Crowdfund, etc.) associated with a specific BTCPay Server store. Returns basic metadata for each app including its ID, name, type, creation timestamp, and archived status. Use this tool when you need to enumerate or discover apps configured within a store. | | `BTCPAY_SERVER_UPDATE_USER` | Update BTCPay Server User | Update the profile of the currently authenticated BTCPay Server user. Use this tool to modify user profile settings like display name, email, profile picture, or password. All fields are optional - only provide fields you want to change. Requires API key with 'btcpay.user.canmodifyprofile' permission scope. Note: Password changes require both currentPassword and newPassword to be provided. Email changes may require re-verification depending on server configuration. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Btcpay server MCP server is an implementation of the Model Context Protocol that connects your AI agent to Btcpay server. It provides structured and secure access so your agent can perform Btcpay server 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 with an active API key - Basic familiarity with Python and async programming ### 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 Install the required libraries. What's happening: - composio connects your agent to external SaaS tools like Btcpay server - pydantic-ai lets you create structured AI agents with tool support - python-dotenv loads your environment variables securely from a .env file ```bash pip install composio pydantic-ai python-dotenv ``` ### 3. Set up environment variables Create a .env file in your project root. What's happening: - COMPOSIO_API_KEY authenticates your agent to Composio's API - USER_ID associates your session with your account for secure tool access - OPENAI_API_KEY to access OpenAI LLMs ```bash COMPOSIO_API_KEY=your_composio_api_key_here USER_ID=your_user_id_here OPENAI_API_KEY=your_openai_api_key ``` ### 4. Import dependencies What's happening: - We load environment variables and import required modules - Composio manages connections to Btcpay server - MCPServerStreamableHTTP connects to the Btcpay server MCP server endpoint - Agent from Pydantic AI lets you define and run the AI assistant ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from pydantic_ai import Agent from pydantic_ai.mcp import MCPServerStreamableHTTP load_dotenv() ``` ### 5. Create a Tool Router Session What's happening: - We're creating a Tool Router session that gives your agent access to Btcpay server tools - The create method takes the user ID and specifies which toolkits should be available - The returned session.mcp.url is the MCP server URL that your agent will use ```python async def main(): api_key = os.getenv("COMPOSIO_API_KEY") user_id = os.getenv("USER_ID") if not api_key or not user_id: raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment") # Create a Composio Tool Router session for Btcpay server composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["btcpay_server"], ) url = session.mcp.url if not url: raise ValueError("Composio session did not return an MCP URL") ``` ### 6. Initialize the Pydantic AI Agent What's happening: - The MCP client connects to the Btcpay server endpoint - The agent uses GPT-5 to interpret user commands and perform Btcpay server operations - The instructions field defines the agent's role and behavior ```python # Attach the MCP server to a Pydantic AI Agent btcpay_server_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[btcpay_server_mcp], instructions=( "You are a Btcpay server assistant. Use Btcpay server tools to help users " "with their requests. Ask clarifying questions when needed." ), ) ``` ### 7. Build the chat interface What's happening: - The agent reads input from the terminal and streams its response - Btcpay server API calls happen automatically under the hood - The model keeps conversation history to maintain context across turns ```python # Simple REPL with message history history = [] print("Chat started! Type 'exit' or 'quit' to end.\n") print("Try asking the agent to help you with Btcpay server.\n") while True: user_input = input("You: ").strip() if user_input.lower() in {"exit", "quit", "bye"}: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n", flush=True) async with agent.run_stream(user_input, message_history=history) as stream_result: collected_text = "" async for chunk in stream_result.stream_output(): text_piece = None if isinstance(chunk, str): text_piece = chunk elif hasattr(chunk, "delta") and isinstance(chunk.delta, str): text_piece = chunk.delta elif hasattr(chunk, "text"): text_piece = chunk.text if text_piece: collected_text += text_piece result = stream_result print(f"Agent: {collected_text}\n") history = result.all_messages() ``` ### 8. Run the application What's happening: - The asyncio loop launches the agent and keeps it running until you exit ```python if __name__ == "__main__": asyncio.run(main()) ``` ## Complete Code ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from pydantic_ai import Agent from pydantic_ai.mcp import MCPServerStreamableHTTP load_dotenv() async def main(): api_key = os.getenv("COMPOSIO_API_KEY") user_id = os.getenv("USER_ID") if not api_key or not user_id: raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment") # Create a Composio Tool Router session for Btcpay server composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["btcpay_server"], ) url = session.mcp.url if not url: raise ValueError("Composio session did not return an MCP URL") # Attach the MCP server to a Pydantic AI Agent btcpay_server_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[btcpay_server_mcp], instructions=( "You are a Btcpay server assistant. Use Btcpay server tools to help users " "with their requests. Ask clarifying questions when needed." ), ) # Simple REPL with message history history = [] print("Chat started! Type 'exit' or 'quit' to end.\n") print("Try asking the agent to help you with Btcpay server.\n") while True: user_input = input("You: ").strip() if user_input.lower() in {"exit", "quit", "bye"}: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n", flush=True) async with agent.run_stream(user_input, message_history=history) as stream_result: collected_text = "" async for chunk in stream_result.stream_output(): text_piece = None if isinstance(chunk, str): text_piece = chunk elif hasattr(chunk, "delta") and isinstance(chunk.delta, str): text_piece = chunk.delta elif hasattr(chunk, "text"): text_piece = chunk.text if text_piece: collected_text += text_piece result = stream_result print(f"Agent: {collected_text}\n") history = result.all_messages() if __name__ == "__main__": asyncio.run(main()) ``` ## Conclusion You've built a Pydantic AI agent that can interact with Btcpay server through Composio's Tool Router. With this setup, your agent can perform real Btcpay server actions through natural language. You can extend this further by: - Adding other toolkits like Gmail, HubSpot, or Salesforce - Building a web-based chat interface around this agent - Using multiple MCP endpoints to enable cross-app workflows (for example, Gmail + Btcpay server for workflow automation) This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations. ## How to build Btcpay server MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/btcpay_server/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/btcpay_server/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/btcpay_server/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/btcpay_server/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/btcpay_server/framework/codex) - [OpenClaw](https://composio.dev/toolkits/btcpay_server/framework/openclaw) - [Hermes](https://composio.dev/toolkits/btcpay_server/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/btcpay_server/framework/cli) - [Google ADK](https://composio.dev/toolkits/btcpay_server/framework/google-adk) - [LangChain](https://composio.dev/toolkits/btcpay_server/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/btcpay_server/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/btcpay_server/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/btcpay_server/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/btcpay_server/framework/crew-ai) ## Related Toolkits - [Addresszen](https://composio.dev/toolkits/addresszen) - Addresszen is a real-time address autocomplete and verification service. It helps capture accurate, deliverable addresses with instant suggestions and validation. - [Asin data api](https://composio.dev/toolkits/asin_data_api) - Asin data api gives you detailed, real-time product data from Amazon, including price, rank, and reviews. Perfect for e-commerce pros and data-driven marketers who need instant marketplace insights. - [Baselinker](https://composio.dev/toolkits/baselinker) - BaseLinker is an all-in-one e-commerce management platform connecting stores, marketplaces, carriers, and more. It streamlines order processing, inventory control, and automates your sales operations. - [Bestbuy](https://composio.dev/toolkits/bestbuy) - Best Buy is a leading retailer offering APIs for product, store, and recommendation data. Instantly access up-to-date retail insights for smarter shopping and decision-making. - [Cdr platform](https://composio.dev/toolkits/cdr_platform) - Cdr platform is an API for purchasing carbon dioxide removal services. It enables businesses to offset emissions by accessing verified carbon removal projects. - [Cloudcart](https://composio.dev/toolkits/cloudcart) - CloudCart is an e-commerce platform for building and managing online stores. It helps businesses streamline product listings, orders, and customer engagement. - [Countdown api](https://composio.dev/toolkits/countdown_api) - Countdown API gives you real-time, structured eBay product data, reviews, and seller feedback. Perfect for powering price monitoring, product research, or marketplace analytics workflows. - [Dpd2](https://composio.dev/toolkits/dpd2) - Dpd2 is a robust email management platform for handling, sorting, and automating email workflows. Streamline your communications and boost productivity with advanced sorting, labeling, and response tools. - [Finerworks](https://composio.dev/toolkits/finerworks) - FinerWorks is an online platform for fine art and photo printing services. Artists and photographers use it to order custom prints and manage print inventory efficiently. - [Fingertip](https://composio.dev/toolkits/fingertip) - Fingertip is a business management platform for selling, booking, and customer engagement—all from a single link. It helps businesses streamline operations and connect with customers across social channels. - [Fraudlabs pro](https://composio.dev/toolkits/fraudlabs_pro) - FraudLabs Pro is an online payment fraud detection service for e-commerce and merchants. It helps minimize chargebacks and revenue loss by detecting and preventing fraudulent transactions. - [Gift up](https://composio.dev/toolkits/gift_up) - Gift Up! is a digital platform for selling, managing, and redeeming gift cards online. It streamlines promotions and gift card transactions for businesses and their customers. - [Goody](https://composio.dev/toolkits/goody) - Goody is a gifting platform that lets users send gifts and physical products without handling logistics. It streamlines gifting by managing delivery, fulfillment, and recipient experience. - [Gumroad](https://composio.dev/toolkits/gumroad) - Gumroad is a platform for selling digital products, physical goods, and memberships with a simple checkout and marketing tools. It streamlines creator payouts and helps you grow your audience effortlessly. - [Instacart](https://composio.dev/toolkits/instacart) - Instacart is an online grocery delivery and pickup service platform. It lets you discover local retailers and create shoppable lists and recipes with ease. - [Junglescout](https://composio.dev/toolkits/junglescout) - Junglescout is an Amazon product research and analytics platform for sellers. It delivers sales estimates, competitive insights, and optimization tools to boost your Amazon business. - [Ko fi](https://composio.dev/toolkits/ko_fi) - Ko-fi is a platform that lets creators receive donations, memberships, and sales from fans. It helps creators monetize their work and grow their audience with minimal friction. - [Lemon squeezy](https://composio.dev/toolkits/lemon_squeezy) - Lemon Squeezy is a payments and subscription platform built for software companies. It makes managing payments, taxes, and customer subscriptions effortless. - [Loyverse](https://composio.dev/toolkits/loyverse) - Loyverse is a point-of-sale (POS) platform for small businesses, offering tools for sales, inventory, and customer loyalty. It helps streamline retail operations and boost customer engagement. - [Memberstack](https://composio.dev/toolkits/memberstack) - Memberstack lets you add user authentication, payments, and member management to your website—no backend code required. Easily manage your site's members and subscriptions from a single platform. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Btcpay server MCP? With a standalone Btcpay server MCP server, the agents and LLMs can only access a fixed set of Btcpay server tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Btcpay server and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with Pydantic AI? Yes, you can. Pydantic AI 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 Btcpay server tools. ### Can I manage the permissions and scopes for Btcpay server while using Tool Router? Yes, absolutely. You can configure which Btcpay server 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 Btcpay server data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)