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

# 使用 AI 开发

> 通过 VelaFi MCP 服务器，将 Claude、ChatGPT、Cursor、VS Code 等 AI 工具连接到 VelaFi 文档，让它们基于最新文档作答。

AI 助手的回答质量取决于它掌握的信息。当您向通用 AI 助手询问 VelaFi API 时，它可能会猜测接口路径、字段名或状态码。VelaFi MCP 服务器让您的 AI 助手以只读方式直接访问本文档，在回答问题或编写代码之前先查阅最新页面。

## MCP 服务器的作用

[Model Context Protocol（MCP）](https://modelcontextprotocol.io)是一项开放标准，让 AI 工具可以连接外部数据源。通过 VelaFi 文档 MCP 服务器，AI 助手可以：

* **搜索文档**：查找指南、API 参考页面、Webhook 和错误码。
* **读取完整页面**：包括请求和响应字段以及示例。

带来的好处：

* **基于最新文档作答**：助手会引用它查阅的页面，而不是依赖训练时学到的内容。
* **减少错误的接口和字段**：生成的代码使用真实的路径、参数和枚举值。
* **在您写代码的地方使用**：在 Claude、ChatGPT、Cursor、VS Code 或终端中直接提问或生成集成代码。
* **覆盖本站所有语言**：助手可以搜索英文、中文和西班牙文文档。

> [!NOTE]
>
> MCP 服务器只读取本站公开的文档。它无法访问您的 VelaFi 账户、调用 VelaFi API 或转移资金，也不需要 API 密钥或登录。切勿将您的 API secret 或令牌粘贴到 AI 对话中。

## 服务器 URL

```text theme={null}
https://docs.velafi.com/mcp
```

## 设置您的 AI 工具

> [tab] Claude
>
> 在网页版 Claude 或 Claude 桌面应用中：
>
> 1. 打开 **Settings → Connectors**（[claude.ai/settings/connectors](https://claude.ai/settings/connectors)）。
> 2. 选择 **Add custom connector**。
> 3. 输入名称（例如 `VelaFi Docs`）和 URL `https://docs.velafi.com/mcp`。
> 4. 选择 **Add**。
> 5. 在对话中打开工具菜单（**+**），启用 VelaFi Docs 连接器。
>
> 并非所有 Claude 套餐都提供自定义连接器，组织管理员也可能限制该功能。

> [tab] Claude Code
>
> 运行：
>
> ```bash theme={null}
> claude mcp add --transport http velafi-docs https://docs.velafi.com/mcp
> ```
>
> 在 Claude Code 中运行 `/mcp`，确认服务器已连接。

> [tab] ChatGPT
>
> 在提供该功能的套餐中，ChatGPT 可通过开发者模式（developer mode）使用自定义 MCP 连接器：
>
> 1. 打开 **Settings → Apps & Connectors → Advanced settings**，开启 **Developer mode**。
> 2. 创建一个连接器，名称为 `VelaFi Docs`，URL 为 `https://docs.velafi.com/mcp`。无需认证。
> 3. 在对话中，从工具菜单启用该连接器。
>
> ChatGPT 更新界面后菜单名称可能会变化。如果找不到这些选项，请在 OpenAI 帮助中心搜索 "developer mode" 和 "MCP connectors"。

> [tab] Cursor
>
> 打开命令面板，运行 **Open MCP settings**，选择 **Add custom MCP** 并添加：
>
> ```json ~/.cursor/mcp.json theme={null}
> {
>   "mcpServers": {
>     "velafi-docs": {
>       "url": "https://docs.velafi.com/mcp"
>     }
>   }
> }
> ```

> [tab] VS Code
>
> 在项目的 `.vscode/mcp.json` 中添加该服务器：
>
> ```json .vscode/mcp.json theme={null}
> {
>   "servers": {
>     "velafi-docs": {
>       "type": "http",
>       "url": "https://docs.velafi.com/mcp"
>     }
>   }
> }
> ```
>
> 然后在 GitHub Copilot Chat 的 agent 模式中使用。

> [tab] Windsurf
>
> 将该服务器添加到 Windsurf 的 MCP 配置中：
>
> ```json ~/.codeium/windsurf/mcp_config.json theme={null}
> {
>   "mcpServers": {
>     "velafi-docs": {
>       "serverUrl": "https://docs.velafi.com/mcp"
>     }
>   }
> }
> ```

> [tab] Codex
>
> 运行：
>
> ```bash theme={null}
> codex mcp add velafi-docs --url https://docs.velafi.com/mcp
> ```

其他支持通过 HTTP 连接远程 MCP 服务器的工具，也可以使用同一个 URL 连接。

## 试一试

连接后，可以向助手提问，例如：

* “根据 VelaFi 文档，如何生成业务令牌？请给出 Python 示例。”
* “通过 SPEI 向墨西哥创建出金订单需要哪些字段？”
* “订单状态 70 是什么意思？哪个 Webhook 会通知我？”
* “写一个处理程序，验证 VelaFi Webhook 的签名。”

在生产环境使用之前，请务必检查生成的代码，并先在[沙盒环境](https://docs.velafi.com/cn/docs/sandbox.md)中测试。

## Agent Skills

如果不只是查阅文档，还可以安装 [VelaFi Agent Skills](https://docs.velafi.com/cn/docs/developer-tools/agent-skills.md)。它们为助手提供每个核心使用场景的分步指令、规则和自检脚本。

## 将文档提供给 AI 的其他方式

* **Markdown 页面**：在任意页面 URL 后加上 `.md`，即可获得纯 Markdown 版本，例如 [`https://docs.velafi.com/docs/quickstart.md`](https://docs.velafi.com/docs/quickstart.md)。
* **页面菜单**：使用任意页面顶部的菜单，可以将页面复制为 Markdown、在 ChatGPT 或 Claude 中打开、复制 MCP 服务器 URL，或一键将 MCP 服务器连接到 Cursor 或 VS Code。
* **llms.txt**：[`/llms.txt`](https://docs.velafi.com/llms.txt) 列出所有页面及简短说明，[`/llms-full.txt`](https://docs.velafi.com/llms-full.txt) 在一个文件中包含文档全文。


## Related topics

- [Agent Skills](https://docs.velafi.com/cn/docs/developer-tools/agent-skills.md)
- [API 概览](https://docs.velafi.com/cn/api-reference/overview.md)
- [认证](https://docs.velafi.com/cn/api-reference/authentication.md)
- [简介](https://docs.velafi.com/cn/docs/introduction.md)
- [核心使用场景](https://docs.velafi.com/cn/docs/use-cases/overview.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.