Kit de herramientas de Stripe Agent

¿Qué es el Kit de Herramientas del Agente?

El ### Kit de Herramientas del Agente es una poderosa biblioteca diseñada para integrar la API de Stripe en flujos de trabajo agénticos utilizando Python y TypeScript. Este kit simplifica el proceso de gestión de pagos y transacciones, permitiendo a los desarrolladores crear experiencias fluidas para los usuarios que interactúan con la plataforma de Stripe.

Características del Kit de Herramientas del Agente

• Soporte Multilenguaje: El kit es compatible tanto con Python como con TypeScript, lo que lo hace versátil para desarrolladores con diferentes antecedentes de programación.
• Integración Fácil: Proporciona métodos sencillos para conectarse con la API de Stripe, permitiendo una configuración y despliegue rápidos.
• Documentación Completa: El kit viene con una extensa documentación disponible en docs.stripe.com/agents, asegurando que los desarrolladores tengan los recursos que necesitan para implementar características de manera efectiva.
• Soporte Comunitario: Como un repositorio público, el Kit de Herramientas del Agente se beneficia de las contribuciones de la comunidad, lo que permite una mejora y actualizaciones continuas.

Cómo Usar el Kit de Herramientas del Agente

1. Instalación: Comienza instalando el kit a través de pip para Python o npm para TypeScript.

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

2. Configuración: Configura tus claves de API de Stripe en tu aplicación para autenticar las solicitudes.

3. Implementación: Utiliza los métodos proporcionados para crear, gestionar y procesar transacciones. El kit incluye funciones para manejar pagos, reembolsos y gestión de clientes.

4. Pruebas: Utiliza las características de prueba integradas para asegurarte de que tu integración funcione como se espera antes de salir en vivo.

5. Despliegue: Una vez probado, despliega tu aplicación y monitorea las transacciones a través del panel de control de Stripe.

Preguntas Frecuentes

P: ¿Qué lenguajes de programación soporta el Kit de Herramientas del Agente?

R: El Kit de Herramientas del Agente soporta tanto Python como TypeScript, lo que lo hace accesible para una amplia gama de desarrolladores.

P: ¿Dónde puedo encontrar la documentación?

R: La documentación está disponible en docs.stripe.com/agents, proporcionando una guía detallada sobre el uso y las características.

P: ¿Es el Kit de Herramientas del Agente de código abierto?

R: Sí, el Kit de Herramientas del Agente es un repositorio público en GitHub, permitiendo a los desarrolladores contribuir y mejorar la biblioteca.

P: ¿Cómo puedo reportar problemas o solicitar características?

R: Puedes reportar problemas o solicitar características creando un problema en el repositorio de GitHub del Kit de Herramientas del Agente.

P: ¿Qué licencia utiliza el Kit de Herramientas del Agente?

R: El Kit de Herramientas del Agente está licenciado bajo la licencia MIT, permitiendo su uso y modificación gratuitos.

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