feat: deploy skill
This commit is contained in:
69
docs/introduction/what-is-agentfox.md
Normal file
69
docs/introduction/what-is-agentfox.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# 什么是 AgentFox
|
||||
|
||||
AgentFox 是一个 MCP 驱动的 API 文档服务,让 AI 编程助手(如 Claude Code、Cursor、GitHub Copilot)能够高效地查询你的 API 文档。
|
||||
|
||||
## 解决什么问题?
|
||||
|
||||
当你使用 AI 编程助手调用第三方 API 时,通常需要将 API 文档提供给 LLM。传统做法是将整个 OpenAPI 规范复制粘贴到对话中,这带来了几个问题:
|
||||
|
||||
- **Token 浪费**:一份完整的 OpenAPI 规范可能消耗 10,000-100,000+ tokens,而你可能只需要其中一个端点的信息
|
||||
- **上下文污染**:大量无关信息会降低 LLM 的理解准确度
|
||||
- **手动操作**:每次都需要手动查找、复制文档
|
||||
|
||||
## AgentFox 如何工作?
|
||||
|
||||
```
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ OpenAPI 文档 │───▶│ AgentFox │───▶│ MCP 端点 │
|
||||
│ (JSON/YAML) │ │ 解析 & 索引 │ │ /mcp/:id │
|
||||
└──────────────┘ └──────────────┘ └──────────────┘
|
||||
│
|
||||
▼
|
||||
┌──────────────┐
|
||||
│ LLM 按需查询 │
|
||||
│ ~200-2K tokens │
|
||||
└──────────────┘
|
||||
```
|
||||
|
||||
1. **导入**:上传 OpenAPI 3.x 或 Swagger 2.0 文档(JSON/YAML 文件或 URL)
|
||||
2. **解析**:AgentFox 自动解引用所有 `$ref`,将文档解析为模块和端点
|
||||
3. **生成 MCP 端点**:每个项目获得唯一的 MCP 服务 URL
|
||||
4. **LLM 按需查询**:AI 工具通过 5 个 MCP 工具渐进式获取所需信息
|
||||
|
||||
## 核心优势
|
||||
|
||||
### 渐进式下钻
|
||||
|
||||
LLM 不需要一次获取所有信息。它可以:
|
||||
- 先查看项目概览,了解有哪些模块
|
||||
- 再查看特定模块的端点列表
|
||||
- 最后获取具体端点的完整参数和响应格式
|
||||
|
||||
### Token 高效
|
||||
|
||||
| 操作 | Token 消耗 |
|
||||
|------|-----------|
|
||||
| `get_project_overview` | ~200 tokens |
|
||||
| `list_modules` | ~100-300 tokens |
|
||||
| `list_endpoints` | ~200-500 tokens |
|
||||
| `get_endpoint_detail` | ~500-2,000 tokens |
|
||||
| `search_endpoints` | ~200-500 tokens |
|
||||
| **全量 OpenAPI 规范** | **10,000-100,000+ tokens** |
|
||||
|
||||
典型的 API 集成任务只需 2-3 次工具调用(约 1,300 tokens),相比全量规范节省 **80-95%** 的 token 消耗。
|
||||
|
||||
### 全规范支持
|
||||
|
||||
- OpenAPI 3.0 / 3.1
|
||||
- Swagger 2.0
|
||||
- JSON 和 YAML 格式
|
||||
- 所有 `$ref` 引用自动解引用
|
||||
|
||||
### 一键导入
|
||||
|
||||
粘贴 URL 或上传文件,API 文档即时解析并索引。支持从 localhost 和内网地址获取文档。
|
||||
|
||||
## 下一步
|
||||
|
||||
- [了解 MCP 协议](what-is-mcp.md)
|
||||
- [快速开始](../getting-started/README.md)
|
||||
65
docs/introduction/what-is-mcp.md
Normal file
65
docs/introduction/what-is-mcp.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# MCP 协议介绍
|
||||
|
||||
MCP(Model Context Protocol)是由 Anthropic 推出的开放标准协议,用于连接 AI 助手与外部工具和数据源。
|
||||
|
||||
## 什么是 MCP?
|
||||
|
||||
你可以把 MCP 理解为 AI 世界的 "USB 接口":
|
||||
|
||||
- **统一标准**:一个协议连接所有 AI 工具和数据源
|
||||
- **双向通信**:AI 助手可以调用工具,也可以接收数据
|
||||
- **安全可控**:每个连接都有明确的权限和认证机制
|
||||
|
||||
```
|
||||
┌────────────┐ MCP 协议 ┌────────────┐
|
||||
│ │◀────────────────────────▶│ │
|
||||
│ MCP 客户端 │ Streamable HTTP │ MCP 服务器 │
|
||||
│ (AI 工具) │ │ (数据源/工具) │
|
||||
│ │ Tools / Resources │ │
|
||||
└────────────┘ └────────────┘
|
||||
|
||||
Claude Code AgentFox
|
||||
Cursor 数据库
|
||||
Copilot 文件系统
|
||||
... ...
|
||||
```
|
||||
|
||||
## MCP 的核心概念
|
||||
|
||||
### Tools(工具)
|
||||
|
||||
MCP 服务器可以向客户端暴露一组工具(函数),AI 助手可以调用这些工具来获取信息或执行操作。
|
||||
|
||||
AgentFox 提供 5 个工具:
|
||||
- `get_project_overview` — 获取项目概览
|
||||
- `list_modules` — 列出所有模块
|
||||
- `list_endpoints` — 列出模块中的端点
|
||||
- `get_endpoint_detail` — 获取端点详情
|
||||
- `search_endpoints` — 搜索端点
|
||||
|
||||
### Transport(传输层)
|
||||
|
||||
MCP 支持多种传输方式。AgentFox 使用 **Streamable HTTP** 传输,这意味着:
|
||||
- 无需安装任何本地插件
|
||||
- 通过标准 HTTP 请求通信
|
||||
- 支持远程连接,适合云端部署
|
||||
|
||||
## AgentFox 如何使用 MCP?
|
||||
|
||||
AgentFox 是一个 **MCP 服务器**,它:
|
||||
|
||||
1. 接收你的 OpenAPI 文档并解析索引
|
||||
2. 为每个项目生成唯一的 MCP 端点 URL
|
||||
3. 通过 5 个 MCP 工具提供按需查询能力
|
||||
4. AI 工具(MCP 客户端)连接到这个端点,即可按需查询 API 文档
|
||||
|
||||
你的 AI 工具(如 Claude Code、Cursor)就是 **MCP 客户端**,它们通过 MCP 协议连接 AgentFox,获取所需的 API 信息。
|
||||
|
||||
## 了解更多
|
||||
|
||||
- [MCP 官方文档](https://modelcontextprotocol.io/)
|
||||
- [MCP 规范](https://spec.modelcontextprotocol.io/)
|
||||
|
||||
## 下一步
|
||||
|
||||
- [快速开始](../getting-started/README.md) — 5 分钟完成首次配置
|
||||
Reference in New Issue
Block a user