Kit de Ferramentas do Agente Stripe

O que é o Agent Toolkit?

O ### Agent Toolkit é uma poderosa biblioteca projetada para integrar a API do Stripe em fluxos de trabalho agentes usando Python e TypeScript. Este toolkit simplifica o processo de gerenciamento de pagamentos e transações, permitindo que os desenvolvedores criem experiências contínuas para os usuários que interagem com a plataforma Stripe.

Recursos do Agent Toolkit

• Suporte a Múltiplas Linguagens: O toolkit suporta tanto Python quanto TypeScript, tornando-o versátil para desenvolvedores com diferentes formações em programação.
• Integração Fácil: Ele fornece métodos diretos para se conectar à API do Stripe, permitindo uma configuração e implantação rápidas.
• Documentação Abrangente: O toolkit vem com documentação extensa disponível em docs.stripe.com/agents, garantindo que os desenvolvedores tenham os recursos necessários para implementar recursos de forma eficaz.
• Suporte da Comunidade: Como um repositório público, o Agent Toolkit se beneficia das contribuições da comunidade, permitindo melhorias e atualizações contínuas.

Como Usar o Agent Toolkit

1. Instalação: Comece instalando o toolkit via pip para Python ou npm para TypeScript.

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

2. Configuração: Configure suas chaves da API do Stripe em seu aplicativo para autenticar solicitações.

3. Implementação: Utilize os métodos fornecidos para criar, gerenciar e processar transações. O toolkit inclui funções para lidar com pagamentos, reembolsos e gerenciamento de clientes.

4. Testes: Use os recursos de teste integrados para garantir que sua integração funcione como esperado antes de entrar em produção.

5. Implantação: Uma vez testado, implante seu aplicativo e monitore transações através do painel do Stripe.

Perguntas Frequentes

Q: Quais linguagens de programação o Agent Toolkit suporta?

R: O Agent Toolkit suporta tanto Python quanto TypeScript, tornando-o acessível para uma ampla gama de desenvolvedores.

Q: Onde posso encontrar a documentação?

R: A documentação está disponível em docs.stripe.com/agents, fornecendo orientações detalhadas sobre uso e recursos.

Q: O Agent Toolkit é de código aberto?

R: Sim, o Agent Toolkit é um repositório público no GitHub, permitindo que os desenvolvedores contribuam e melhorem a biblioteca.

Q: Como posso relatar problemas ou solicitar recursos?

R: Você pode relatar problemas ou solicitar recursos criando uma issue no repositório do GitHub para o Agent Toolkit.

Q: Qual licença o Agent Toolkit utiliza?

R: O Agent Toolkit é licenciado sob a licença MIT, permitindo uso e modificação 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