apifox-mcp-server 0.0.6 → 0.0.7-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -20
- package/lib/index.js +49 -51
- package/package.json +4 -26
package/README.md
CHANGED
|
@@ -1,18 +1,53 @@
|
|
|
1
|
-
# Apifox
|
|
1
|
+
# Apifox MCP Server
|
|
2
2
|
|
|
3
|
-
使用 Apifox MCP Server，可以将 Apifox 项目内的接口文档作为数据源提供给
|
|
4
|
-
|
|
3
|
+
使用 Apifox MCP Server，可以将 Apifox 项目内的接口文档作为数据源提供给 Cursor 等支持 AI 编程的 IDE 工具
|
|
4
|
+
以便让 AI 能够直接访问项目对应的接口文档数据。
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
开发者可以通过 AI 助手完成以下工作：根据接口文档生成或修改代码、搜索接口文档内容等等，
|
|
7
|
+
至于通过这个接口文档数据能让 AI 干什么更多更强大的活，请发挥你和你们团队的想象力😜
|
|
7
8
|
|
|
8
|
-
##
|
|
9
|
+
## 🎯 如何使用
|
|
9
10
|
|
|
10
|
-
|
|
11
|
+
安装配置好 MCP 后，Apifox MCP Server 会自动读取 Apifox 整个项目里的所有接口文档的数据并缓存在本地电脑，
|
|
12
|
+
AI 可以通过 MCP 读取项目内所有的接口的接口文档数据。
|
|
13
|
+
|
|
14
|
+
你只要告诉 AI 你想要通过 API 文档做什么即可，示例：
|
|
15
|
+
|
|
16
|
+
1. “通过 MCP 获取 API 文档，然后生成 Product 及其相关模型的定义代码”
|
|
17
|
+
2. “根据 API 文档，然后在 Product DTO 里添加 API 文档新增的几个字段”
|
|
18
|
+
3. “根据 API 文档给 Product 类的每个字段都加上注释”
|
|
19
|
+
4. “根据 API 文档，生成接口 /users 相关的所有 MVC 代码”
|
|
20
|
+
|
|
21
|
+
注意：接口文档数据默认是会缓存在本地的，如果 Apifox 内的数据有更新，请告诉 AI 刷新接口文档数据，
|
|
22
|
+
否则 AI 读到数据可能不是最新的。
|
|
23
|
+
|
|
24
|
+
## 🚀 安装方法
|
|
25
|
+
|
|
26
|
+
### 前置条件
|
|
27
|
+
|
|
28
|
+
- 已安装 Node.js 环境（版本号 >= 18，推荐最新的 LTS 版本）
|
|
29
|
+
- 任意一个支持 MCP 的 IDE：
|
|
30
|
+
- Cursor
|
|
31
|
+
- Windsurf
|
|
32
|
+
- VSCode + Cline 插件
|
|
33
|
+
|
|
34
|
+
### 安装
|
|
35
|
+
|
|
36
|
+
1. **在 Apifox 生成 Access Token**
|
|
37
|
+
a. 打开 Apifox，将鼠标悬停在页面右上角的头像上，点击 “账号设置 -> API 访问令牌”
|
|
38
|
+
b. 创建新的 API 访问令牌，详见帮助文档
|
|
39
|
+
c. 拿到 API 访问令牌，替换下面配置文件中的 `<access-token>`
|
|
40
|
+
2. **获取 Apifox 项目 ID**
|
|
41
|
+
a. 打开 Apifox 里对应的项目
|
|
42
|
+
b. 在左侧边栏点击“项目设置”，在“基本设置”页面即可复制项目 ID
|
|
43
|
+
c. 拿到项目 ID，替换下面配置文件中的 `<project-id>`
|
|
44
|
+
3. **配置 IDE**
|
|
45
|
+
将下面 JSON 配置添加到 IDE 对应的 MCP 配置文件里：
|
|
11
46
|
|
|
12
47
|
```json
|
|
13
48
|
{
|
|
14
49
|
"mcpServers": {
|
|
15
|
-
"
|
|
50
|
+
"API 文档": {
|
|
16
51
|
"command": "npx",
|
|
17
52
|
"args": [
|
|
18
53
|
"-y",
|
|
@@ -20,26 +55,24 @@ Node.js 版本需要 >= 18。
|
|
|
20
55
|
"--project=<project-id>"
|
|
21
56
|
],
|
|
22
57
|
"env": {
|
|
23
|
-
// 也可以在操作系统配置名为 APIFOX_ACCESS_TOKEN 的环境变量
|
|
24
58
|
"APIFOX_ACCESS_TOKEN": "<access-token>"
|
|
25
59
|
}
|
|
26
60
|
}
|
|
27
61
|
}
|
|
28
62
|
}
|
|
29
63
|
```
|
|
64
|
+
- Cursor：添加到全局的 `~/.cursor/mcp.json` 或项目内的 `.cursor/mcp.json`
|
|
65
|
+
- Windsurf：添加到 `~/.codeium/windsurf/mcp_config.json`
|
|
66
|
+
- Cline：打开 Cline 面板 > MCP Server > Configure MCP Server
|
|
30
67
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
在“基本设置”页面即可复制项目 ID。使用真实项目 ID，替换上面配置文件中的 <project-id>。
|
|
37
|
-
|
|
38
|
-
然后，使用 ⌘+I 打开 Agent 模式的 AI 对话界面，用自然语言和 AI 对话，
|
|
39
|
-
比如：根据接口文档，生成 Product 相关接口的代码，使用 Express.js。
|
|
68
|
+
**注意：**
|
|
69
|
+
1. 请将上面的 `<access-token>` 和 `<project-id>` 替换为你个人的 Apifox API 访问令牌和 Apifox 项目 ID。
|
|
70
|
+
2. 配置文件里 MCP Server 名字建议填写类似“API 文档”或“xxx API 文档”这样的包含“API文档”字眼的名称，这样 AI 更容易正确的识别这个 MCP Server 的用途。不建议填写“Apifox”或“Apifox MCP”，这种写法 AI 不容易识别用途。
|
|
71
|
+
3. 如果需要使用到多个项目的 API 文档，在配置文件里添加配置多个 MCP Server 即可（不同项目有不同的`<project-id>`）， MCP Server 的名字填写“xxx API 文档”。
|
|
72
|
+
4. 如果团队习惯将 MCP 配置文件同步到代码仓库里，建议删除配置里的"APIFOX_ACCESS_TOKEN": "`<access-token>`"，改成每个成员在自己电脑里配置名为 APIFOX_ACCESS_TOKEN 的环境变量，以避免 APIFOX_ACCESS_TOKEN 泄漏问题。
|
|
40
73
|
|
|
41
|
-
##
|
|
74
|
+
## ❓帮助与支持
|
|
42
75
|
|
|
43
|
-
|
|
76
|
+
Apifox MCP Server 还在内测阶段，欢迎各位给我们提建议和想法，请加内测群：
|
|
44
77
|
|
|
45
|
-
|