Stripeエージェントツールキット
PythonとTypeScriptのライブラリで、エージェントワークフローにStripe APIを統合します。
概要
エージェントツールキットとは?
エージェントツールキットは、PythonとTypeScriptを使用してStripe APIをエージェントワークフローに統合するために設計された強力なライブラリです。このツールキットは、支払いと取引の管理プロセスを簡素化し、開発者がStripeプラットフォームとやり取りするユーザーにシームレスな体験を提供できるようにします。
エージェントツールキットの特徴
- マルチ言語サポート:ツールキットはPythonとTypeScriptの両方をサポートしており、異なるプログラミングバックグラウンドを持つ開発者にとって多用途です。
- 簡単な統合:Stripe APIとの接続を簡単に行えるメソッドを提供し、迅速なセットアップとデプロイを可能にします。
- 包括的なドキュメント:ツールキットには、docs.stripe.com/agentsで入手可能な広範なドキュメントが付属しており、開発者が機能を効果的に実装するためのリソースを確保しています。
- コミュニティサポート:公開リポジトリとして、エージェントツールキットはコミュニティの貢献を受けており、継続的な改善と更新が可能です。
エージェントツールキットの使い方
-
インストール:まず、Pythonの場合はpip、TypeScriptの場合はnpmを使用してツールキットをインストールします。
- Pythonの場合:
pip install agent-toolkit
- TypeScriptの場合:
npm install agent-toolkit
- Pythonの場合:
-
設定:アプリケーション内でStripe APIキーを設定し、リクエストを認証します。
-
実装:提供されているメソッドを利用して、取引を作成、管理、処理します。ツールキットには、支払い、返金、顧客管理を処理するための関数が含まれています。
-
テスト:組み込みのテスト機能を使用して、ライブにする前に統合が期待通りに機能することを確認します。
-
デプロイ:テストが完了したら、アプリケーションをデプロイし、Stripeダッシュボードを通じて取引を監視します。
よくある質問
Q: エージェントツールキットはどのプログラミング言語をサポートしていますか?
A: エージェントツールキットはPythonとTypeScriptの両方をサポートしており、幅広い開発者にアクセス可能です。
Q: ドキュメントはどこで見つけられますか?
A: ドキュメントはdocs.stripe.com/agentsで入手可能で、使用法や機能に関する詳細なガイダンスを提供しています。
Q: エージェントツールキットはオープンソースですか?
A: はい、エージェントツールキットはGitHubの公開リポジトリであり、開発者がライブラリに貢献し改善することができます。
Q: 問題を報告したり機能をリクエストするにはどうすればよいですか?
A: エージェントツールキットのGitHubリポジトリで問題を作成することで、問題を報告したり機能をリクエストできます。
Q: エージェントツールキットはどのライセンスを使用していますか?
A: エージェントツールキットは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
サーバー設定
{
"mcpServers": {
"modelcontextprotocol": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/metorial/mcp-container--stripe--agent-toolkit--modelcontextprotocol",
"node dist/index.js --tools tools --api-key api-key"
],
"env": {}
}
}
}
Stripeエージェントツールキット 代替案
以下の代替サービスとしてStripeエージェントツールキットが必要な場合、カテゴリ別にご案内しています。