Files
agent-fox/docs/faq.md
2026-04-12 20:15:41 +08:00

48 lines
2.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 常见问题
## 什么是 MCPAgentFox 如何使用它?
MCPModel Context Protocol是一个开放标准让 AI 助手能够连接外部工具和数据源。AgentFox 通过 MCP 工具暴露你的 API 文档,让 Claude Code、Cursor、Copilot 等 AI 编程助手可以按需查询端点详情,而无需将整个规范放入上下文窗口。
## 支持哪些 OpenAPI 格式?
AgentFox 支持 OpenAPI 3.x 和 Swagger 2.0 规范。你可以导入 JSON 或 YAML 格式的文档,也可以提供 URL 直接获取。导入时所有 `$ref` 引用会自动解引用。
## 能减少多少 Token 消耗?
每次 MCP 工具调用返回约 200-2,000 tokens 的精准信息,相比全量 API 规范的 10,000+ tokens。对于典型的集成任务这意味着 **80-95%** 的 token 消耗降低。
## 我的 API 文档安全吗?
是的。每个账号拥有独立的 API Keybcrypt 哈希加密从不以明文存储。MCP 端点每次请求都需要认证。用户控制台使用 JWT 并自动轮换 token。
## 兼容哪些 AI 工具?
任何支持 MCP 协议的工具都可以连接 AgentFox包括 Claude Desktop、Claude Code、Cursor、Windsurf、GitHub Copilot、Cline、OpenAI Codex CLI、Gemini CLI 等。如果你的工具支持 MCP就能与 AgentFox 配合使用。
## 可以私有化部署吗?
可以。AgentFox 支持云端和私有化部署。企业版包含完整的 Docker Compose 私有化部署支持,以及 SSO 集成和专属技术支持。
## 如何更新已导入的 API 文档?
在项目详情的「设置」标签中,点击「重新导入文档」。重新导入会替换所有模块和端点数据,但项目 ID 和 API Key 保持不变LLM 客户端无需重新配置。详见 [重新导入文档](project-management/reimport-docs.md)。
## 丢失了 API Key 怎么办?
如果你是邮箱注册的用户,可以在「设置」中通过密码验证查看已有 Key。如果完全无法找回可以轮换生成新的 Key旧 Key 会立即失效)。详见 [API Key 管理](project-management/api-key-management.md)。
## MCP 连接失败怎么排查?
1. 确认 `type``http`(不是 `sse``stdio`
2. 确认 URL 中的 projectId 正确
3. 确认 API Key 有效且格式为 `Bearer {key}`
4. 确认网络可以访问 `www.agentfoxapp.com`
5. 尝试重启 AI 工具
详见 [客户端配置概述](clients/README.md) 中的连接排障部分。
## 一个 API Key 可以用于多个项目吗?
是的。AgentFox 的 API Key 是账号级别的,一个 Key 对你账号下的所有项目生效。你只需要在 MCP 配置中使用不同的项目 URL 即可。