Stripe Agent Toolkit

Was ist das Agent Toolkit?

Das ### Agent Toolkit ist eine leistungsstarke Bibliothek, die für die Integration der Stripe API in agentische Workflows mit Python und TypeScript entwickelt wurde. Dieses Toolkit vereinfacht den Prozess der Verwaltung von Zahlungen und Transaktionen und ermöglicht es Entwicklern, nahtlose Erfahrungen für Benutzer zu schaffen, die mit der Stripe-Plattform interagieren.

Funktionen des Agent Toolkits

• Mehrsprachige Unterstützung: Das Toolkit unterstützt sowohl Python als auch TypeScript, was es vielseitig für Entwickler mit unterschiedlichen Programmierhintergründen macht.
• Einfache Integration: Es bietet unkomplizierte Methoden zur Verbindung mit der Stripe API, die eine schnelle Einrichtung und Bereitstellung ermöglichen.
• Umfassende Dokumentation: Das Toolkit kommt mit umfangreicher Dokumentation, die unter docs.stripe.com/agents verfügbar ist, und stellt sicher, dass Entwickler die Ressourcen haben, die sie benötigen, um Funktionen effektiv zu implementieren.
• Community-Unterstützung: Als öffentliches Repository profitiert das Agent Toolkit von Beiträgen der Community, was kontinuierliche Verbesserungen und Updates ermöglicht.

So verwenden Sie das Agent Toolkit

1. Installation: Beginnen Sie mit der Installation des Toolkits über pip für Python oder npm für TypeScript.

   • Für Python: pip install agent-toolkit
   • Für TypeScript: npm install agent-toolkit

2. Konfiguration: Richten Sie Ihre Stripe API-Schlüssel in Ihrer Anwendung ein, um Anfragen zu authentifizieren.

3. Implementierung: Nutzen Sie die bereitgestellten Methoden, um Transaktionen zu erstellen, zu verwalten und zu verarbeiten. Das Toolkit enthält Funktionen zur Handhabung von Zahlungen, Rückerstattungen und Kundenverwaltung.

4. Testen: Verwenden Sie die integrierten Testfunktionen, um sicherzustellen, dass Ihre Integration wie erwartet funktioniert, bevor Sie live gehen.

5. Bereitstellung: Sobald Sie getestet haben, stellen Sie Ihre Anwendung bereit und überwachen Sie die Transaktionen über das Stripe-Dashboard.

Häufig gestellte Fragen

F: Welche Programmiersprachen unterstützt das Agent Toolkit?

A: Das Agent Toolkit unterstützt sowohl Python als auch TypeScript, was es für eine breite Palette von Entwicklern zugänglich macht.

F: Wo finde ich die Dokumentation?

A: Die Dokumentation ist unter docs.stripe.com/agents verfügbar und bietet detaillierte Anleitungen zur Nutzung und zu den Funktionen.

F: Ist das Agent Toolkit Open Source?

A: Ja, das Agent Toolkit ist ein öffentliches Repository auf GitHub, das Entwicklern ermöglicht, zur Bibliothek beizutragen und sie zu verbessern.

F: Wie kann ich Probleme melden oder Funktionen anfordern?

A: Sie können Probleme melden oder Funktionen anfordern, indem Sie ein Issue im GitHub-Repository des Agent Toolkits erstellen.

F: Unter welcher Lizenz steht das Agent Toolkit?

A: Das Agent Toolkit ist unter der MIT-Lizenz lizenziert, die eine kostenlose Nutzung und Modifikation erlaubt.

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