Outil de l'Agent Stripe

Qu'est-ce que l'Agent Toolkit ?

L'### Agent Toolkit est une bibliothèque puissante conçue pour intégrer l'API Stripe dans des flux de travail agentiques en utilisant Python et TypeScript. Cet outil simplifie le processus de gestion des paiements et des transactions, permettant aux développeurs de créer des expériences fluides pour les utilisateurs interagissant avec la plateforme Stripe.

Caractéristiques de l'Agent Toolkit

• Support multi-langue : L'outil prend en charge à la fois Python et TypeScript, le rendant polyvalent pour les développeurs ayant des parcours de programmation différents.
• Intégration facile : Il fournit des méthodes simples pour se connecter à l'API Stripe, permettant une configuration et un déploiement rapides.
• Documentation complète : L'outil est accompagné d'une documentation exhaustive disponible sur docs.stripe.com/agents, garantissant que les développeurs disposent des ressources nécessaires pour mettre en œuvre les fonctionnalités efficacement.
• Support communautaire : En tant que dépôt public, l'Agent Toolkit bénéficie des contributions de la communauté, permettant une amélioration continue et des mises à jour.

Comment utiliser l'Agent Toolkit

1. Installation : Commencez par installer l'outil via pip pour Python ou npm pour TypeScript.

   • Pour Python : pip install agent-toolkit
   • Pour TypeScript : npm install agent-toolkit

2. Configuration : Configurez vos clés API Stripe dans votre application pour authentifier les requêtes.

3. Mise en œuvre : Utilisez les méthodes fournies pour créer, gérer et traiter les transactions. L'outil comprend des fonctions pour gérer les paiements, les remboursements et la gestion des clients.

4. Test : Utilisez les fonctionnalités de test intégrées pour vous assurer que votre intégration fonctionne comme prévu avant de passer en production.

5. Déploiement : Une fois testé, déployez votre application et surveillez les transactions via le tableau de bord Stripe.

Questions Fréquemment Posées

Q : Quelles langues de programmation l'Agent Toolkit prend-il en charge ?

R : L'Agent Toolkit prend en charge à la fois Python et TypeScript, le rendant accessible à un large éventail de développeurs.

Q : Où puis-je trouver la documentation ?

R : La documentation est disponible sur docs.stripe.com/agents, fournissant des conseils détaillés sur l'utilisation et les fonctionnalités.

Q : L'Agent Toolkit est-il open-source ?

R : Oui, l'Agent Toolkit est un dépôt public sur GitHub, permettant aux développeurs de contribuer et d'améliorer la bibliothèque.

Q : Comment puis-je signaler des problèmes ou demander des fonctionnalités ?

R : Vous pouvez signaler des problèmes ou demander des fonctionnalités en créant un problème sur le dépôt GitHub de l'Agent Toolkit.

Q : Quelle licence utilise l'Agent Toolkit ?

R : L'Agent Toolkit est sous licence MIT, permettant une utilisation et une modification gratuites.

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