Stripe 代理工具包

什么是代理工具包？

代理工具包是一个强大的库，旨在使用 Python 和 TypeScript 将 Stripe API 集成到代理工作流程中。该工具包简化了管理支付和交易的过程，使开发人员能够为与 Stripe 平台交互的用户创建无缝体验。

代理工具包的特点

• 多语言支持：该工具包支持 Python 和 TypeScript，使其对不同编程背景的开发人员具有多样性。
• 简单集成：提供简单的方法与 Stripe API 连接，便于快速设置和部署。
• 全面文档：该工具包附带了详细的文档，文档可在 docs.stripe.com/agents 获取，确保开发人员拥有有效实施功能所需的资源。
• 社区支持：作为一个公共库，代理工具包受益于社区贡献，允许持续改进和更新。

如何使用代理工具包

1. 安装：首先通过 pip 安装 Python 版本或通过 npm 安装 TypeScript 版本的工具包。

   • 对于 Python：pip install agent-toolkit
   • 对于 TypeScript：npm install agent-toolkit

2. 配置：在您的应用程序中设置 Stripe API 密钥以验证请求。

3. 实现：利用提供的方法创建、管理和处理交易。该工具包包括处理支付、退款和客户管理的功能。

4. 测试：使用内置的测试功能确保您的集成在上线前按预期工作。

5. 部署：测试完成后，部署您的应用程序并通过 Stripe 仪表板监控交易。

常见问题解答

问：代理工具包支持哪些编程语言？

答：代理工具包支持 Python 和 TypeScript，使其对广泛的开发人员可访问。

问：我在哪里可以找到文档？

答：文档可在 docs.stripe.com/agents 获取，提供有关使用和功能的详细指导。

问：代理工具包是开源的吗？

答：是的，代理工具包是 GitHub 上的公共库，允许开发人员贡献和改进该库。

问：我如何报告问题或请求功能？

答：您可以通过在代理工具包的 GitHub 仓库中创建问题来报告问题或请求功能。

问：代理工具包使用什么许可证？

答：代理工具包使用 MIT 许可证，允许免费使用和修改。

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

• Create a customer
• List all customers
• Create a coupon
• List all coupons
• Create a product
• List all products
• Create a price
• List all prices
• Create a payment link
• Create an invoice
• Create an invoice item
• Finalize an invoice
• Retrieve balance
• List all subscriptions
• Update a subscription
• Cancel a subscription
• Create a refund
• List all disputes
• Update a dispute