MCP ExplorerExplorer

Stripe Model Context Protocol

@stripeon 11 days ago
821 MIT
FreeOfficial
Finance
#stripe#payments#customers#refunds
The Stripe Model Context Protocol server allows you to integrate with Stripe APIs through function calling. This protocol supports various tools to interact with different Stripe services.

Overview

What is Stripe Model Context Protocol

The Stripe Agent Toolkit is a library that facilitates integration with Stripe APIs using popular agent frameworks such as OpenAI’s Agent SDK, LangChain, CrewAI, Vercel’s AI SDK, and the Model Context Protocol (MCP). It is designed for both Python and TypeScript, providing functionalities built on top of the official Stripe SDKs.

Use cases

The toolkit can be used to automate tasks involving payment processing, customer management, invoicing, and subscription management in Stripe. It supports creating customers, products, prices, payment links, invoices, and refunds, making it useful for businesses that require programmatic access to Stripe’s services.

How to use

To use the Stripe Agent Toolkit, install the appropriate package for your programming language (Python or TypeScript), configure it with your Stripe secret key, and define the actions you intend to perform. For example, create instances of the toolkit and pass them as tools to agent frameworks, allowing you to execute various Stripe API calls.

Key features

Key features include the ability to create and manage customers, products, prices, payment links, and subscriptions. The toolkit also supports context management for connected accounts, middleware for billing events, and interactions with various agent frameworks, enhancing automation and billing capabilities.

Where to use

The toolkit can be used in any application that requires integration with Stripe for payment processing and financial operations. It is particularly applicable in e-commerce platforms, subscription services, and any software that requires automated handling of customer and payment-related tasks.

Content

Stripe Agent Toolkit

The Stripe Agent Toolkit enables popular agent frameworks including OpenAI’s Agent SDK, LangChain, CrewAI, Vercel’s AI SDK, and Model Context Protocol (MCP) to integrate with Stripe APIs through function calling. The
library is not exhaustive of the entire Stripe API. It includes support for both Python and TypeScript and is built directly on top of the Stripe Python and Node SDKs.

Included below are basic instructions, but refer to the Python and TypeScript packages for more information.

Python

Installation

You don’t need this source code unless you want to modify the package. If you just
want to use the package run:

pip install stripe-agent-toolkit

Requirements

  • Python 3.11+

Usage

The library needs to be configured with your account’s secret key which is
available in your Stripe Dashboard.

from stripe_agent_toolkit.openai.toolkit import StripeAgentToolkit

stripe_agent_toolkit = StripeAgentToolkit(
    secret_key="sk_test_...",
    configuration={
        "actions": {
            "payment_links": {
                "create": True,
            },
        }
    },
)

The toolkit works with OpenAI’s Agent SDK, LangChain, and CrewAI and can be passed as a list of tools. For example:

from agents import Agent

stripe_agent = Agent(
    name="Stripe Agent",
    instructions="You are an expert at integrating with Stripe",
    tools=stripe_agent_toolkit.get_tools()
)

Examples for OpenAI’s Agent SDK,LangChain, and CrewAI are included in /examples.

Context

In some cases you will want to provide values that serve as defaults when making requests. Currently, the account context value enables you to make API calls for your connected accounts.

stripe_agent_toolkit = StripeAgentToolkit(
    secret_key="sk_test_...",
    configuration={
        "context": {
            "account": "acct_123"
        }
    }
)

TypeScript

Installation

You don’t need this source code unless you want to modify the package. If you just
want to use the package run:

npm install @stripe/agent-toolkit

Requirements

  • Node 18+

Usage

The library needs to be configured with your account’s secret key which is available in your Stripe Dashboard. Additionally, configuration enables you to specify the types of actions that can be taken using the toolkit.

import { StripeAgentToolkit } from "@stripe/agent-toolkit/langchain";

const stripeAgentToolkit = new StripeAgentToolkit({
  secretKey: process.env.STRIPE_SECRET_KEY!,
  configuration: {
    actions: {
      paymentLinks: {
        create: true,
      },
    },
  },
});

Tools

The toolkit works with LangChain and Vercel’s AI SDK and can be passed as a list of tools. For example:

import { AgentExecutor, createStructuredChatAgent } from "langchain/agents";

const tools = stripeAgentToolkit.getTools();

const agent = await createStructuredChatAgent({
  llm,
  tools,
  prompt,
});

const agentExecutor = new AgentExecutor({
  agent,
  tools,
});

Context

In some cases you will want to provide values that serve as defaults when making requests. Currently, the account context value enables you to make API calls for your connected accounts.

const stripeAgentToolkit = new StripeAgentToolkit({
  secretKey: process.env.STRIPE_SECRET_KEY!,
  configuration: {
    context: {
      account: "acct_123",
    },
  },
});

Metered billing

For Vercel’s AI SDK, you can use middleware to submit billing events for usage. All that is required is the customer ID and the input/output meters to bill.

import { StripeAgentToolkit } from "@stripe/agent-toolkit/ai-sdk";
import { openai } from "@ai-sdk/openai";
import {
  generateText,
  experimental_wrapLanguageModel as wrapLanguageModel,
} from "ai";

const stripeAgentToolkit = new StripeAgentToolkit({
  secretKey: process.env.STRIPE_SECRET_KEY!,
  configuration: {
    actions: {
      paymentLinks: {
        create: true,
      },
    },
  },
});

const model = wrapLanguageModel({
  model: openai("gpt-4o"),
  middleware: stripeAgentToolkit.middleware({
    billing: {
      customer: "cus_123",
      meters: {
        input: "input_tokens",
        output: "output_tokens",
      },
    },
  }),
});

Model Context Protocol

The Stripe Agent Toolkit also supports the Model Context Protocol (MCP).

To run the Stripe MCP server using npx, use the following command:

npx -y @stripe/mcp --tools=all --api-key=YOUR_STRIPE_SECRET_KEY

Replace YOUR_STRIPE_SECRET_KEY with your actual Stripe secret key. Or, you could set the STRIPE_SECRET_KEY in your environment variables.

Alternatively, you can set up your own MCP server. For example:

import { StripeAgentToolkit } from "@stripe/agent-toolkit/modelcontextprotocol";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";

const server = new StripeAgentToolkit({
  secretKey: process.env.STRIPE_SECRET_KEY!,
  configuration: {
    actions: {
      paymentLinks: {
        create: true,
      },
      products: {
        create: true,
      },
      prices: {
        create: true,
      },
    },
  },
});

async function main() {
  const transport = new StdioServerTransport();
  await server.connect(transport);
  console.error("Stripe MCP Server running on stdio");
}

main().catch((error) => {
  console.error("Fatal error in main():", error);
  process.exit(1);
});

Supported API methods

Tools

create_customer
This tool will create a customer in Stripe. It takes two arguments: - name (str): The name of the customer. - email (str, optional): The email of the customer.
list_customers
This tool will fetch a list of Customers from Stripe. It takes no input.
create_product
This tool will create a product in Stripe. It takes two arguments: - name (str): The name of the product. - description (str, optional): The description of the product.
list_products
This tool will fetch a list of Products from Stripe. It takes one optional argument: - limit (int, optional): The number of products to return.
create_price
This tool will create a price in Stripe. If a product has not already been specified, a product should be created first. It takes three arguments: - product (str): The ID of the product to create the price for. - unit_amount (int): The unit amount of the price in cents. - currency (str): The currency of the price.
list_prices
This tool will fetch a list of Prices from Stripe. It takes two arguments. - product (str, optional): The ID of the product to list prices for. - limit (int, optional): The number of prices to return.
create_payment_link
This tool will create a payment link in Stripe. It takes two arguments: - price (str): The ID of the price to create the payment link for. - quantity (int): The quantity of the product to include in the payment link.
create_invoice
This tool will create an invoice in Stripe. It takes two arguments: - customer (str): The ID of the customer to create the invoice for. - days_until_due (int, optional): The number of days until the invoice is due.
create_invoice_item
This tool will create an invoice item in Stripe. It takes two arguments: - customer (str): The ID of the customer to create the invoice item for. - price (str): The ID of the price to create the invoice item for. - invoice (str): The ID of the invoice to create the invoice item for.
finalize_invoice
This tool will finalize an invoice in Stripe. It takes one argument: - invoice (str): The ID of the invoice to finalize.
retrieve_balance
This tool will retrieve the balance from Stripe. It takes no input.
create_refund
This tool will refund a payment intent in Stripe. It takes three arguments: - payment_intent (str): The ID of the payment intent to refund. - amount (int, optional): The amount to refund in cents. - reason (str, optional): The reason for the refund.
list_payment_intents
This tool will list payment intents in Stripe. It takes two arguments: - customer (str, optional): The ID of the customer to list payment intents for. - limit (int, optional): The number of payment intents to return.
search_documentation
This tool will take in a user question about integrating with Stripe in their application, then search and retrieve relevant Stripe documentation to answer the question. It takes two arguments: - question (str): The user question to search an answer for in the Stripe documentation. - language (str, optional): The programming language to search for in the the documentation.

Comments