# How to integrate Btcpay server MCP with Claude Code ```json { "title": "How to integrate Btcpay server MCP with Claude Code", "toolkit": "Btcpay server", "toolkit_slug": "btcpay_server", "framework": "Claude Code", "framework_slug": "claude-code", "url": "https://composio.dev/toolkits/btcpay_server/framework/claude-code", "markdown_url": "https://composio.dev/toolkits/btcpay_server/framework/claude-code.md", "updated_at": "2026-05-12T10:04:21.597Z" } ``` ## Introduction Manage your Btcpay server directly from Claude Code with zero worries about OAuth hassles, API-breaking issues, or reliability and security concerns. You can do this in two different ways: - Via [Composio Connect](https://dashboard.composio.dev/login?utm_source=toolkits&utm_medium=framework_template&utm_campaign=claude-code&utm_content=composio_connect&next=%2F~%2Forg%2Fconnect%2Fclients%2Fclaude-code) - Direct and easiest approach - Via [Composio SDK](https://docs.composio.dev/docs?utm_source=toolkits&utm_medium=framework_template&utm_campaign=claude-code&utm_content=composio_sdk) - Programmatic approach with more control ## 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 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 - Only one MCP URL to connect multiple apps with Claude Code with zero auth hassles. - Programmatic tool calling allows LLMs to write its code in a remote workbench to handle complex tool chaining. Reduces to-and-fro with LLMs for frequent tool calling. - Handling Large tool responses out of LLM context to minimize context rot. - Dynamic just-in-time access to 20,000 tools across 1000+ other Apps for cross-app workflows. It loads the tools you need, so LLMs aren't overwhelmed by tools you don't need. ## Connect Btcpay server to Claude Code ### Connecting Btcpay server to Claude Code using Composio 1. Add the Composio MCP to Claude ```bash claude mcp add --scope user --transport http composio https://connect.composio.dev/mcp ``` ## What is Claude Code? Claude Code is Anthropic's command line developer tool that lets you use Claude directly inside your terminal. Instead of switching between your editor, browser, and chat, you can stay in your project folder and ask Claude to help you build, debug, refactor, and understand code right where you're working. Key features include: - Terminal-Native Experience: Work with Claude directly in your command line without switching contexts - MCP Support: Built-in support for Model Context Protocol servers to extend Claude's capabilities - Project Context: Claude understands your project structure and can read, write, and modify files - Interactive Development: Ask questions, debug code, and get help in real-time while coding - Multi-Platform: Works on macOS, Linux, WSL, and Windows ## 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 Claude Code (and other AI assistants like Claude and Cursor) directly to your Btcpay server account. It provides structured and secure access so Claude can perform Btcpay server operations on your behalf. 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: - Claude Pro, Max, or API billing enabled Anthropic account - Composio API Key - A Btcpay server account - Basic knowledge of Python or TypeScript ### 1. Install Claude Code To install Claude Code, use one of the following methods based on your operating system: ```bash # macOS, Linux, WSL curl -fsSL https://claude.ai/install.sh | bash # Windows PowerShell irm https://claude.ai/install.ps1 | iex # Windows CMD curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd ``` ### 2. Set up Claude Code Open a terminal, go to your project folder, and start Claude Code: - Claude Code will open in your terminal - Follow the prompts to sign in with your Anthropic account - Complete the authentication flow - Once authenticated, you can start using Claude Code ```bash cd your-project-folder claude ``` ### 3. Set up environment variables Create a .env file in your project root with the following variables: - COMPOSIO_API_KEY authenticates with Composio (get it from [Composio dashboard](https://dashboard.composio.dev/login?utm_source=toolkits&utm_medium=framework_template&utm_campaign=claude-code&utm_content=api_key&next=%2F~%2Forg%2Fconnect%2Fclients%2Fclaude-code)) - USER_ID identifies the user for session management (use any unique identifier) ```bash COMPOSIO_API_KEY=your_composio_api_key_here USER_ID=your_user_id_here ``` ### 4. Install Composio library No description provided. ```python pip install composio-core python-dotenv ``` ```typescript npm install @composio/core dotenv ``` ### 5. Generate Composio MCP URL No description provided. ```python import os from composio import Composio from dotenv import load_dotenv load_dotenv() COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY") USER_ID = os.getenv("USER_ID") composio_client = Composio(api_key=COMPOSIO_API_KEY) composio_session = composio_client.create( user_id=USER_ID, toolkits=["btcpay_server"], ) COMPOSIO_MCP_URL = composio_session.mcp.url print(f"MCP URL: {COMPOSIO_MCP_URL}") print(f"\nUse this command to add to Claude Code:") print(f'claude mcp add --transport http btcpay_server-composio "{COMPOSIO_MCP_URL}" --headers "X-API-Key:{COMPOSIO_API_KEY}"') ``` ```typescript import 'dotenv/config'; import { Composio } from '@composio/core'; const { COMPOSIO_API_KEY, USER_ID } = process.env; if (!COMPOSIO_API_KEY || !USER_ID) { throw new Error('COMPOSIO_API_KEY and USER_ID required in .env'); } const composioClient = new Composio({ apiKey: COMPOSIO_API_KEY }); const composioSession = await composioClient.create(USER_ID, { toolkits: ['btcpay_server'], }); const composioMcpUrl = composioSession?.mcp.url; console.log(`MCP URL: ${composioMcpUrl}`); console.log(`\nUse this command to add to Claude Code:`); console.log(`claude mcp add --transport http btcpay_server-composio "${composioMcpUrl}" --headers "X-API-Key:${COMPOSIO_API_KEY}"`); ``` ### 6. Run the script and copy the MCP URL No description provided. ```python python generate_mcp_url.py ``` ```typescript node --loader ts-node/esm generate_mcp_url.ts # or if using tsx tsx generate_mcp_url.ts ``` ### 7. Add Btcpay server MCP to Claude Code In your terminal, add the MCP server using the command from the previous step. The command format is: - claude mcp add registers a new MCP server with Claude Code - --transport http specifies that this is an HTTP-based MCP server - The server name (btcpay_server-composio) is how you'll reference it - The URL points to your Composio Tool Router session - --headers includes your Composio API key for authentication After running the command, close the current Claude Code session and start a new one for the changes to take effect. ```bash claude mcp add --transport http btcpay_server-composio "YOUR_MCP_URL_HERE" --headers "X-API-Key:YOUR_COMPOSIO_API_KEY" # Then restart Claude Code exit claude ``` ### 8. Verify the installation Check that your Btcpay server MCP server is properly configured. - This command lists all MCP servers registered with Claude Code - You should see your btcpay_server-composio entry in the list - This confirms that Claude Code can now access Btcpay server tools If everything is wired up, you should see your btcpay_server-composio entry listed: ```bash claude mcp list ``` ### 9. Authenticate Btcpay server The first time you try to use Btcpay server tools, you'll be prompted to authenticate. - Claude Code will detect that you need to authenticate with Btcpay server - It will show you an authentication link - Open the link in your browser (or copy/paste it) - Complete the Btcpay server authorization flow - Return to the terminal and start using Btcpay server through Claude Code Once authenticated, you can ask Claude Code to perform Btcpay server operations in natural language. For example: - "Create a new Bitcoin payment request for my store" - "List all payment requests for store ABC123" - "Register a webhook for payment notifications" ## Complete Code ```python import os from composio import Composio from dotenv import load_dotenv load_dotenv() COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY") USER_ID = os.getenv("USER_ID") composio_client = Composio(api_key=COMPOSIO_API_KEY) composio_session = composio_client.create( user_id=USER_ID, toolkits=["btcpay_server"], ) COMPOSIO_MCP_URL = composio_session.mcp.url print(f"MCP URL: {COMPOSIO_MCP_URL}") print(f"\nUse this command to add to Claude Code:") print(f'claude mcp add --transport http btcpay_server-composio "{COMPOSIO_MCP_URL}" --headers "X-API-Key:{COMPOSIO_API_KEY}"') ``` ```typescript import 'dotenv/config'; import { Composio } from '@composio/core'; const { COMPOSIO_API_KEY, USER_ID } = process.env; if (!COMPOSIO_API_KEY || !USER_ID) { throw new Error('COMPOSIO_API_KEY and USER_ID required in .env'); } const composioClient = new Composio({ apiKey: COMPOSIO_API_KEY }); const composioSession = await composioClient.create(USER_ID, { toolkits: ['btcpay_server'], }); const composioMcpUrl = composioSession?.mcp.url; console.log(`MCP URL: ${composioMcpUrl}`); console.log(`\nUse this command to add to Claude Code:`); console.log(`claude mcp add --transport http btcpay_server-composio "${composioMcpUrl}" --headers "X-API-Key:${COMPOSIO_API_KEY}"`); ``` ## Conclusion You've successfully integrated Btcpay server with Claude Code using Composio's MCP server. Now you can interact with Btcpay server directly from your terminal using natural language commands. Key features of this setup: - Terminal-native experience without switching contexts - Natural language commands for Btcpay server operations - Secure authentication through Composio's managed MCP - Tool Router for dynamic tool discovery and execution Next steps: - Try asking Claude Code to perform various Btcpay server operations - Add more toolkits to your Tool Router session for multi-app workflows - Integrate this setup into your development workflow for increased productivity You can extend this by adding more toolkits, implementing custom workflows, or building automation scripts that leverage Claude Code's capabilities. ## 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 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 Claude Code? Yes, you can. Claude Code 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)