feat: deploy skill
This commit is contained in:
51
docs/project-management/api-key-management.md
Normal file
51
docs/project-management/api-key-management.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# API Key 管理
|
||||
|
||||
API Key 是 LLM 客户端连接 AgentFox MCP 服务的唯一认证凭证。
|
||||
|
||||
## 基本信息
|
||||
|
||||
- 每个账号只有一个 API Key
|
||||
- 该 Key 对账号下所有项目生效
|
||||
- Key 以 `afk_` 为前缀
|
||||
- 使用 bcrypt 哈希加密存储,不保存明文
|
||||
|
||||
## 生成 API Key
|
||||
|
||||
首次使用时需要生成:
|
||||
|
||||
1. 打开「设置」(点击右上角头像旁的齿轮图标)
|
||||
2. 在「API Key」区域,点击「生成 API Key」
|
||||
3. **立即复制并保存**生成的密钥
|
||||
|
||||
> **重要**:API Key 仅在生成时完整显示一次。
|
||||
|
||||
## 查看/复制已有 Key
|
||||
|
||||
如果之前已生成过 API Key:
|
||||
|
||||
1. 打开「设置」→ API Key 区域
|
||||
2. 点击「查看」或「复制」
|
||||
3. 输入账号密码进行身份验证
|
||||
4. 验证通过后可查看或复制
|
||||
|
||||
> **提示**:通过 Google/GitHub 登录的用户,需要先在「设置」中设置密码,才能执行此操作。
|
||||
|
||||
## 轮换 API Key
|
||||
|
||||
如果密钥泄露或出于安全考虑需要更换:
|
||||
|
||||
1. 打开「设置」→ API Key 区域
|
||||
2. 点击「轮换 API Key」
|
||||
3. 确认操作
|
||||
|
||||
轮换后的影响:
|
||||
- 旧密钥**立即失效**
|
||||
- 所有使用旧密钥的 MCP 客户端需要更新配置
|
||||
- 新密钥同样只显示一次,请立即保存
|
||||
|
||||
## 安全建议
|
||||
|
||||
- 不要将 API Key 提交到版本控制系统
|
||||
- 将包含 API Key 的 MCP 配置文件添加到 `.gitignore`
|
||||
- 定期轮换 API Key
|
||||
- 如果怀疑密钥泄露,立即轮换
|
||||
45
docs/project-management/module-management.md
Normal file
45
docs/project-management/module-management.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# 模块管理
|
||||
|
||||
模块是 AgentFox 中端点的分组方式。导入 API 文档时,端点会自动按规则分组到不同模块中。
|
||||
|
||||
## 自动分组规则
|
||||
|
||||
导入 API 文档时,AgentFox 按以下优先级自动创建模块:
|
||||
|
||||
1. **OpenAPI Tags**:如果端点定义了 `tags`,按 tag 名称分组
|
||||
2. **路径前缀**:如果没有 tags,按 URL 路径的第一段分组(如 `/users/...` → `users` 模块)
|
||||
|
||||
## 查看模块
|
||||
|
||||
在项目详情页的「模块」标签中,可以查看所有模块:
|
||||
|
||||
- 模块名称
|
||||
- 模块中的端点数量
|
||||
- 模块来源类型(tag / path_prefix / manual)
|
||||
|
||||
## 手动添加模块
|
||||
|
||||
1. 在「模块」标签页顶部,输入模块名称
|
||||
2. 点击「添加」按钮
|
||||
3. 新模块将显示在列表中(端点数量为 0)
|
||||
|
||||
手动添加的模块可用于重新组织端点。
|
||||
|
||||
## 删除模块
|
||||
|
||||
1. 在模块列表中,找到要删除的模块
|
||||
2. 点击删除按钮
|
||||
3. 确认删除
|
||||
|
||||
> **注意**:删除模块会同时删除模块中的所有端点。此操作不可撤销。
|
||||
|
||||
## 模块对 MCP 工具的影响
|
||||
|
||||
模块直接影响 LLM 的查询体验:
|
||||
|
||||
- `get_project_overview` 返回所有模块的 ID 和端点数量
|
||||
- `list_modules` 返回模块的详细描述
|
||||
- `list_endpoints` 需要传入 `moduleId` 来查看特定模块的端点
|
||||
- `search_endpoints` 可选传入 `moduleId` 来限定搜索范围
|
||||
|
||||
合理的模块划分有助于 LLM 更快定位到所需的端点。
|
||||
34
docs/project-management/reimport-docs.md
Normal file
34
docs/project-management/reimport-docs.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# 重新导入文档
|
||||
|
||||
当 API 文档更新后,你可以重新导入来更新 AgentFox 中的数据。
|
||||
|
||||
## 何时需要重新导入?
|
||||
|
||||
- API 新增了端点
|
||||
- 端点的参数或响应格式发生了变化
|
||||
- 模块结构需要重新组织
|
||||
|
||||
## 重新导入步骤
|
||||
|
||||
1. 进入项目详情页 → 「设置」标签
|
||||
2. 在「重新导入 API 文档」区域,点击「重新导入文档」
|
||||
3. 选择导入方式(URL 或上传文件)
|
||||
4. 确认导入
|
||||
|
||||
## 重要提醒
|
||||
|
||||
> **注意**:重新导入会删除当前项目中的所有模块和端点,然后根据新文档重新创建。
|
||||
|
||||
重新导入时:
|
||||
- 所有现有模块将被删除
|
||||
- 所有现有端点将被删除
|
||||
- **API Key 保持不变**(LLM 客户端无需更新配置)
|
||||
- **项目 ID 保持不变**(MCP URL 不变)
|
||||
|
||||
## 支持的格式
|
||||
|
||||
与首次导入相同:
|
||||
- OpenAPI 3.0 / 3.1
|
||||
- Swagger 2.0
|
||||
- JSON 和 YAML 格式
|
||||
- URL 或文件上传
|
||||
Reference in New Issue
Block a user