> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 使用 AI 代码代理构建

> 使用 Dodo Agent 插件与 Claude Code、Codex CLI、Cursor 和 OpenCode 构建集成 —— MCP 服务器和技能一次安装。

Dodo Agent 插件将两个 MCP 服务器和八个集成技能连接到您的 AI 代码代理中，一次安装即可。它可以与 **Claude Code**、**Codex CLI**、**Cursor** 和 **OpenCode** 一起工作 —— MCP 服务器和技能 CLI 可以与任何 MCP 兼容的客户端配合使用。

<Info>
  **三个原语，一个插件。** Agent 插件打包了您需要的一切：

  * **API MCP 服务器** —— 实时访问支付、订阅、客户、产品、退款、许可证和使用情况。通过浏览器 OAuth 进行身份验证（不需要本地密钥）。
  * **Knowledge MCP 服务器** —— 在所有 Dodo Payments 文档中进行语义搜索。不需要凭证。
  * **八个代理技能** —— 您的代理按需加载的备忘单，用于结账、订阅、webhooks、基于使用的计费、基于信用的计费、许可证密钥、BillingSDK 和最佳实践。
</Info>

## 安装插件

在下方选择您的代码代理。安装会自动添加两个 MCP 服务器和全部八个技能。

<AccordionGroup>
  <Accordion title="Claude Code" defaultOpen>
    从市场安装：

    ```bash theme={null}
    claude plugins marketplace add dodopayments/dodo-agent-plugin
    claude plugins install dodopayments@dodopayments
    ```

    API MCP 服务器默认使用浏览器 OAuth —— 安装时不需要密钥。您的代理首次调用 Dodo 工具时，会提示您登录。

    <Card title="Dodo Agent Plugin on GitHub" icon="github" href="https://github.com/dodopayments/dodo-agent-plugin">
      源码、配置选项和本地开发说明
    </Card>
  </Accordion>

  <Accordion title="Codex CLI">
    Codex 通过两个步骤安装插件：从您的 shell 注册市场，然后从 Codex TUI 内安装插件。

    <Steps>
      <Step title="Register the marketplace">
        ```bash theme={null}
        codex plugin marketplace add dodopayments/dodo-agent-plugin
        ```
      </Step>

      <Step title="Install from the Codex TUI">
        打开 Codex 并运行 `/plugins` 斜杠命令：

        ```bash theme={null}
        codex
        ```

        然后输入 `/plugins`，切换到 **Dodo Payments** 市场，选择 **dodopayments** 插件，并选择 **安装插件**。
      </Step>
    </Steps>

    一旦插件安装，两个 MCP 服务器和全部八个技能就会自动注册。

    <Note>
      Codex CLI 没有 `codex plugin install` 子命令 —— 插件安装总是通过 in-TUI `/plugins` 流程进行。查看 [官方 Codex 插件文档](https://developers.openai.com/codex/plugins)。
    </Note>

    如果您之前添加了市场且插件未显示在 `/plugins`，下拉刷新：

    ```bash theme={null}
    codex plugin marketplace upgrade dodopayments
    ```
  </Accordion>

  <Accordion title="Cursor">
    手动安装 —— 将 repo 克隆到 Cursor 的本地插件目录：

    ```bash theme={null}
    git clone https://github.com/dodopayments/dodo-agent-plugin.git ~/.cursor/plugins/local/dodo-agent-plugin
    ```

    重启 Cursor。插件从 `.claude/skills/` 加载技能（通过 Cursor 的 Claude Code 兼容层），从 `.mcp.json` 加载 MCP 服务器。

    <Info>
      Cursor 市场支持即将推出。暂时，请使用上述手动安装。
    </Info>
  </Accordion>

  <Accordion title="OpenCode">
    OpenCode 通过 npm 分发。将插件添加到您的 `opencode.json`：

    ```json theme={null}
    {
      "$schema": "https://opencode.ai/config.json",
      "plugin": ["@dodopayments/opencode-plugin"]
    }
    ```

    重启 OpenCode。两个 MCP 服务器（`dodopayments-api`，`dodo-knowledge`）通过插件的配置挂钩自动注册，八个技能从已安装的软件包中自动发现。不需要手动 `mcp` 块。
  </Accordion>
</AccordionGroup>

<Info>
  使用不同的代理？[MCP 服务器](/developer-resources/mcp-server) 和 [代理技能](/developer-resources/agent-skills) 指南涵盖 Cursor、Claude Desktop、VS Code、Windsurf、Cline、Zed 和任何 MCP 兼容的客户端。
</Info>

## 您将获得的内容

一旦插件安装，您的代理就可以访问两个 MCP 服务器和八个技能。

### MCP 服务器

| 服务器                | 目的                                   | 认证         |
| ------------------ | ------------------------------------ | ---------- |
| `dodopayments-api` | 实时 API 访问 —— 支付、订阅、客户、产品、退款、许可证、使用情况 | OAuth（浏览器） |
| `dodo-knowledge`   | 在所有 Dodo Payments 文档中进行语义搜索          | 无          |

两个服务器通过 `mcp-remote` 连接，因此它们可以在任何 MCP 兼容的客户端中运行。

### 代理技能

| 技能                         | 描述                         |
| -------------------------- | -------------------------- |
| `best-practices`           | Dodo Payments 的综合集成指南和最佳实践 |
| `checkout-integration`     | 创建结账会话和支付流程                |
| `subscription-integration` | 实现订阅计费流程                   |
| `webhook-integration`      | 设置和处理支付事件的 webhooks        |
| `usage-based-billing`      | 使用事件和计量器实施计量计费             |
| `credit-based-billing`     | 信用权利、余额和计量信用扣减             |
| `license-keys`             | 管理数字产品的许可证密钥               |
| `billing-sdk`              | 使用 BillingSDK React 组件     |

技能自动加载——您的代理在检测到相关任务时选择合适的技能。查看 [代理技能文档](/developer-resources/agent-skills) 获取完整列表和单独安装信息。

### 首先尝试此提示

插件激活后，请尝试：

```
Set up Dodo Payments webhook handlers in my Next.js app for payment.succeeded and subscription.active events.
```

您的代理将加载 `webhook-integration` 技能，使用 `dodo-knowledge` MCP 提取最新的负载形状，并按照标准 Webhooks 规范编写带签名验证的处理程序。

## 其他受支持的代理

Agent 插件涵盖 Claude Code、Codex CLI、Cursor 和 OpenCode。如果您使用其他代理，请通过 MCP 服务器和技能 CLI 连接到 Dodo Payments：

| 代理                       | 最快路径                                         | 还支持                                         |
| ------------------------ | -------------------------------------------- | ------------------------------------------- |
| **Claude Code**          | Agent 插件（一条命令）                               | MCP 服务器，单个技能                                |
| **Codex CLI**            | Agent 插件（一条命令）                               | MCP 服务器                                     |
| **Cursor**               | Agent 插件（git clone）                          | MCP 服务器配置，技能 CLI                            |
| **OpenCode**             | Agent 插件（npm）                                | MCP 服务器配置，技能 CLI                            |
| GitHub Copilot (VS Code) | [MCP 服务器指南](/developer-resources/mcp-server) | [技能 CLI](/developer-resources/agent-skills) |
| Claude Desktop           | [MCP 服务器指南](/developer-resources/mcp-server) | —                                           |
| Windsurf                 | [MCP 服务器指南](/developer-resources/mcp-server) | [技能 CLI](/developer-resources/agent-skills) |
| Cline / Zed / others     | [MCP 服务器指南](/developer-resources/mcp-server) | [技能 CLI](/developer-resources/agent-skills) |

## 为代理量身定制的文档

每个 Dodo Payments 文档页面都可以以优化 AI 消费的格式获取：

* **完整文档索引**: [`docs.dodopayments.com/llms.txt`](https://docs.dodopayments.com/llms.txt) — 提供完整的文档索引以进行上下文摄取。
* **纯 Markdown**: 将 `.md` 添加到任何文档 URL 以获取原始 Markdown 版本（例如，`/api-reference/introduction.md`）。
* **源代码仓库**: [`github.com/dodopayments/dodo-docs`](https://github.com/dodopayments/dodo-docs) — 克隆以进行离线索引。

## 您的代理可以做什么

安装插件后，您的代码代理可以：

* **创建结账会话和支付链接** — [一次性支付](/features/one-time-payment-products) 和 [订阅](/features/subscription)
* **支持完整的订阅和基于使用的计费** — [订阅](/features/subscription)、[基于使用的计费](/features/usage-based-billing/introduction)、[基于信用的计费](/features/credit-based-billing)
* **生成符合标准 Webhooks 的处理程序**，带有签名验证 — [Webhooks](/developer-resources/webhooks)
* **连接 BillingSDK React 组件** 用于定价表和订阅管理 — [BillingSDK](/developer-resources/billingsdk)
* **编写数字产品的许可证密钥流程** — [许可证密钥](/features/license-keys)
* **实施基于信用的计费**，包括权利、余额、结转和超额 — [Credits](/features/credit-based-billing)

## 安全性和最佳实践

<Warning>
  **永远不要提交生产 API 密钥。** 在开发过程中使用 [测试模式](/miscellaneous/test-mode-vs-live-mode)。Agent 插件默认使用浏览器 OAuth — 只有当您的工作流程需要时才切换到本地 API 密钥。
</Warning>

* **先使用测试模式。** 在上线前用 `dodo_test_...` 密钥对您的集成进行沙箱测试。参见 [测试模式与实时模式](/miscellaneous/test-mode-vs-live-mode)。
* **OAuth 是默认。** Agent 插件通过浏览器 OAuth 进行身份验证（没有本地秘密）。只有在需要时才使用 API 密钥模式 —— 见下面的配置部分。
* **审查代理生成的代码。** 始终验证 webhook 处理程序是否包含按 [标准 Webhooks 规范](https://standardwebhooks.com/) 进行的签名验证。

## 使用 API 密钥进行配置

默认情况下，Agent 插件使用远程 MCP 服务器与浏览器 OAuth —— 不需要本地凭证。如果您的工作流程需要本地 API 密钥（例如，CI 环境、无头服务器），可以切换到 stdio 模式。

<AccordionGroup>
  <Accordion title="Local API key mode — Claude Code">
    在 Claude Code 中打开 `/plugins`，选择 **Dodo Payments**，并选择 **配置选项**。填写：

    * `dodo_api_key` — 您的 `dodo_test_...` 或 `dodo_live_...` 密钥
    * `dodo_webhook_key` — 您的 webhook 签名秘密
    * `dodo_environment` — `test_mode` 或 `live_mode`

    然后编辑 `.mcp.json` 以将 `dodopayments-api` 指向本地 stdio 服务器：

    ```json theme={null}
    {
      "mcpServers": {
        "dodopayments-api": {
          "type": "stdio",
          "command": "npx",
          "args": ["-y", "dodopayments-mcp@latest"],
          "env": {
            "DODO_PAYMENTS_API_KEY": "${user_config.dodo_api_key}",
            "DODO_PAYMENTS_WEBHOOK_KEY": "${user_config.dodo_webhook_key}",
            "DODO_PAYMENTS_ENVIRONMENT": "${user_config.dodo_environment}"
          }
        }
      }
    }
    ```

    运行 `/reload-plugins` 以应用更改到当前会话。
  </Accordion>

  <Accordion title="Local API key mode — OpenCode">
    根据您的需要在 `opencode.json` 中声明 `dodopayments-api` —— 您的入口将取代插件的默认远程服务器：

    ```json theme={null}
    {
      "$schema": "https://opencode.ai/config.json",
      "plugin": ["@dodopayments/opencode-plugin"],
      "mcp": {
        "dodopayments-api": {
          "type": "local",
          "command": ["npx", "-y", "dodopayments-mcp@latest"],
          "environment": {
            "DODO_PAYMENTS_API_KEY": "dodo_test_...",
            "DODO_PAYMENTS_WEBHOOK_KEY": "whsec_...",
            "DODO_PAYMENTS_ENVIRONMENT": "test_mode"
          },
          "enabled": true
        }
      }
    }
    ```

    重新启动 OpenCode 以应用。
  </Accordion>
</AccordionGroup>

## 下一步

<CardGroup cols={2}>
  <Card title="MCP Server" icon="terminal" href="/developer-resources/mcp-server">
    两个 MCP 服务器的完整参考手册 —— 支持的所有客户、配置和可用工具
  </Card>

  <Card title="Agent Skills" icon="wand-magic-sparkles" href="/developer-resources/agent-skills">
    单个技能安装、技能参考和每个代理的设置说明
  </Card>

  <Card title="Sentra IDE Assistant" icon="bolt" href="/developer-resources/sentra">
    面向 VS Code、Cursor 和 Windsurf 的 AI 驱动计费助手 —— 在您的编辑器中询问、构建和规划
  </Card>

  <Card title="API Reference" icon="book" href="/api-reference/introduction">
    所有 Dodo Payments 端点的完整 OpenAPI 参考
  </Card>
</CardGroup>