40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
# 快速开始
|
||
|
||
只需 4 步，即可让你的 AI 编程助手通过 MCP 查询 API 文档。
|
||
|
||
## 准备工作
|
||
|
||
- 一个浏览器（用于访问 AgentFox 控制台）
|
||
- 一份 OpenAPI 3.x 或 Swagger 2.0 文档（JSON/YAML 文件或可访问的 URL）
|
||
- 一个支持 MCP 的 AI 工具（Claude Code、Cursor、Copilot 等）
|
||
|
||
## 步骤
|
||
|
||
| 步骤 | 说明 | 耗时 |
|
||
|------|------|------|
|
||
| 1. [注册与登录](register-and-login.md) | 创建 AgentFox 账号 | 1 分钟 |
|
||
| 2. [导入 API 文档](import-api-docs.md) | 上传 OpenAPI 文档 | 1 分钟 |
|
||
| 3. [生成 API Key](generate-api-key.md) | 获取 MCP 认证密钥 | 30 秒 |
|
||
| 4. [连接 LLM 客户端](connect-first-client.md) | 配置 AI 工具 | 2 分钟 |
|
||
|
||
完成后，你的 AI 助手就可以直接查询 API 文档了。
|
||
|
||
## 完成效果
|
||
|
||
配置完成后，你可以在 AI 工具中这样使用：
|
||
|
||
```
|
||
你：帮我调用 Stripe 的创建支付接口
|
||
|
||
AI：让我先查看一下 API 文档...
|
||
[调用 get_project_overview]
|
||
[调用 list_endpoints moduleId="payments"]
|
||
[调用 get_endpoint_detail endpointId="create-charge"]
|
||
|
||
根据 API 文档，创建支付的接口是：
|
||
POST /v1/charges
|
||
需要参数：amount, currency, source...
|
||
```
|
||
|
||
AI 助手会自动通过 MCP 工具获取所需信息，无需你手动复制文档。
|