feat: deploy skill
This commit is contained in:
39
docs/getting-started/README.md
Normal file
39
docs/getting-started/README.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# 快速开始
|
||||
|
||||
只需 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 工具获取所需信息,无需你手动复制文档。
|
||||
75
docs/getting-started/connect-first-client.md
Normal file
75
docs/getting-started/connect-first-client.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# 连接第一个 LLM 客户端
|
||||
|
||||
现在你已经有了项目和 API Key,可以将 AI 工具连接到 AgentFox 的 MCP 服务。
|
||||
|
||||
## 获取 MCP 配置信息
|
||||
|
||||
在项目详情页的「MCP」标签页中,你可以找到:
|
||||
|
||||
1. **MCP 服务 URL**:`https://www.agentfoxapp.com/mcp/{你的项目ID}`
|
||||
2. **配置代码片段**:可一键复制的 JSON 配置
|
||||
|
||||
## 通用配置模板
|
||||
|
||||
所有支持 MCP 的 AI 工具都使用类似的配置格式:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"my-api": {
|
||||
"type": "http",
|
||||
"url": "https://www.agentfoxapp.com/mcp/{projectId}",
|
||||
"headers": {
|
||||
"Authorization": "Bearer {your-api-key}"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
将 `{projectId}` 替换为你的项目 ID(从 MCP 标签页复制),将 `{your-api-key}` 替换为你的 API Key。
|
||||
|
||||
## 快速示例:Claude Code
|
||||
|
||||
以 Claude Code 为例,最快的连接方式:
|
||||
|
||||
1. 在项目根目录创建 `.mcp.json` 文件:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"my-api": {
|
||||
"type": "http",
|
||||
"url": "https://www.agentfoxapp.com/mcp/你的项目ID",
|
||||
"headers": {
|
||||
"Authorization": "Bearer 你的API-Key"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. 重启 Claude Code,即可使用
|
||||
|
||||
## 验证连接
|
||||
|
||||
连接成功后,你可以让 AI 助手执行一个简单的测试:
|
||||
|
||||
```
|
||||
你:调用 get_project_overview 查看 API 概览
|
||||
```
|
||||
|
||||
如果返回了项目名称、版本和模块列表,说明连接成功。
|
||||
|
||||
## 各客户端详细配置
|
||||
|
||||
不同 AI 工具的配置方式略有差异,请参考对应的详细指南:
|
||||
|
||||
- [Claude Desktop](../clients/claude-desktop.md)
|
||||
- [Claude Code](../clients/claude-code.md)
|
||||
- [Cursor](../clients/cursor.md)
|
||||
- [Windsurf](../clients/windsurf.md)
|
||||
- [GitHub Copilot](../clients/github-copilot.md)
|
||||
- [Cline](../clients/cline.md)
|
||||
- [Codex (OpenAI)](../clients/codex.md)
|
||||
- [其他客户端](../clients/other-clients.md)
|
||||
49
docs/getting-started/generate-api-key.md
Normal file
49
docs/getting-started/generate-api-key.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# 生成 API Key
|
||||
|
||||
API Key 是 LLM 客户端连接 AgentFox MCP 服务的认证凭证。你需要先生成一个 API Key 才能使用 MCP 服务。
|
||||
|
||||
## 生成步骤
|
||||
|
||||
1. 进入任意项目的详情页
|
||||
2. 点击页面顶部的「设置」(用户头像旁)
|
||||
3. 在「API Key」区域,点击「生成 API Key」
|
||||
4. 生成的密钥会立即显示
|
||||
|
||||
> **重要**:API Key 仅在生成时显示一次,之后无法再次查看完整密钥。请立即复制并安全保存。
|
||||
|
||||
## API Key 格式
|
||||
|
||||
API Key 以 `afk_` 为前缀,例如:
|
||||
|
||||
```
|
||||
afk_dGhpcyBpcyBhIHNhbXBsZQ
|
||||
```
|
||||
|
||||
## 安全说明
|
||||
|
||||
- API Key 使用 bcrypt 哈希加密存储,AgentFox 不保存明文密钥
|
||||
- 一个账号只有一个 API Key,对该账号下所有项目生效
|
||||
- 如果你通过第三方登录(Google/GitHub),需要先在「设置」中设置密码,才能查看或复制 API Key
|
||||
|
||||
## 查看和复制已有 Key
|
||||
|
||||
如果你之前已生成过 API Key:
|
||||
|
||||
1. 打开「设置」
|
||||
2. 在 API Key 区域,点击「查看」或「复制」
|
||||
3. 输入账号密码进行验证
|
||||
4. 验证通过后可查看或复制完整密钥
|
||||
|
||||
## 轮换 API Key
|
||||
|
||||
如果密钥泄露或需要更新:
|
||||
|
||||
1. 打开「设置」→ API Key 区域
|
||||
2. 点击「轮换 API Key」
|
||||
3. 确认操作
|
||||
|
||||
> **注意**:轮换后旧密钥立即失效,所有使用旧密钥的 MCP 客户端需要更新配置。
|
||||
|
||||
## 下一步
|
||||
|
||||
拿到 API Key 后,就可以 [连接你的第一个 LLM 客户端](connect-first-client.md) 了。
|
||||
59
docs/getting-started/import-api-docs.md
Normal file
59
docs/getting-started/import-api-docs.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# 导入 API 文档
|
||||
|
||||
AgentFox 支持导入 OpenAPI 3.x 和 Swagger 2.0 格式的 API 文档。
|
||||
|
||||
## 导入方式
|
||||
|
||||
### 方式一:从 URL 导入
|
||||
|
||||
1. 在控制台点击「导入 API 文档」按钮
|
||||
2. 选择「从 URL」标签
|
||||
3. 粘贴 OpenAPI 文档的 URL
|
||||
4. 点击「导入」
|
||||
|
||||
> **提示**:支持 localhost 和内网地址。AgentFox 会先尝试在浏览器端直接获取,如果遇到 CORS 限制,会自动通过服务端代理获取。
|
||||
|
||||
### 方式二:上传文件
|
||||
|
||||
1. 在控制台点击「导入 API 文档」按钮
|
||||
2. 选择「上传文件」标签
|
||||
3. 拖放文件到上传区域,或点击选择文件
|
||||
4. 支持 `.json`、`.yaml`、`.yml` 格式
|
||||
5. 点击「导入」
|
||||
|
||||
## 支持的格式
|
||||
|
||||
| 格式 | 版本 | 说明 |
|
||||
|------|------|------|
|
||||
| OpenAPI | 3.0 / 3.1 | 推荐,功能最完整 |
|
||||
| Swagger | 2.0 | 完整支持,自动转换 body 参数为 requestBody 格式 |
|
||||
|
||||
支持的文件类型:
|
||||
- JSON(`.json`)
|
||||
- YAML(`.yaml` / `.yml`)
|
||||
|
||||
## 导入后会发生什么?
|
||||
|
||||
1. **验证**:AgentFox 使用 `swagger-parser` 验证文档格式
|
||||
2. **解引用**:所有 `$ref` 引用被自动展开
|
||||
3. **分组**:端点按 OpenAPI tags 或 URL 路径前缀自动分组为模块
|
||||
4. **索引**:所有端点的参数、请求体、响应格式被索引存储
|
||||
|
||||
导入成功后,你将看到:
|
||||
- 项目名称(来自文档的 `info.title`)
|
||||
- 解析出的模块数量
|
||||
- 解析出的端点数量
|
||||
|
||||
## 示例:导入 Petstore API
|
||||
|
||||
你可以用以下公开的 OpenAPI 文档来测试:
|
||||
|
||||
```
|
||||
https://petstore3.swagger.io/api/v3/openapi.json
|
||||
```
|
||||
|
||||
导入后将创建包含多个模块(pet、store、user)和对应端点的项目。
|
||||
|
||||
## 下一步
|
||||
|
||||
文档导入成功后,接下来 [生成 API Key](generate-api-key.md) 以启用 MCP 服务。
|
||||
31
docs/getting-started/register-and-login.md
Normal file
31
docs/getting-started/register-and-login.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# 注册与登录
|
||||
|
||||
## 创建账号
|
||||
|
||||
访问 [www.agentfoxapp.com](https://www.agentfoxapp.com),点击右上角的「免费开始」按钮。
|
||||
|
||||
### 方式一:邮箱注册
|
||||
|
||||
1. 点击「注册」
|
||||
2. 填写姓名、邮箱和密码(至少 8 个字符)
|
||||
3. 点击「创建账号」
|
||||
4. 自动跳转到控制台
|
||||
|
||||
### 方式二:第三方登录
|
||||
|
||||
AgentFox 支持以下第三方登录:
|
||||
|
||||
- **Google** — 使用 Google 账号快速登录
|
||||
- **GitHub** — 使用 GitHub 账号快速登录
|
||||
|
||||
点击对应的图标即可跳转到授权页面,授权后自动返回 AgentFox 控制台。
|
||||
|
||||
> **提示**:通过第三方登录的用户,如需查看或复制 API Key,需要先在「设置」中设置密码。
|
||||
|
||||
## 登录
|
||||
|
||||
已有账号的用户,直接在登录页输入邮箱和密码,或使用之前关联的第三方账号登录。
|
||||
|
||||
## 下一步
|
||||
|
||||
登录成功后,你将进入控制台。接下来 [导入你的第一份 API 文档](import-api-docs.md)。
|
||||
Reference in New Issue
Block a user