MCP 集成
ApiSorcery 内置了 MCP(Model Context Protocol)服务器,让 AI 编程助手能够直接调用 generate、init、register — 无需手动执行 CLI 命令。
工作原理
全局安装后,会同时提供两个二进制命令:
| 命令 | 说明 |
|---|---|
apisorcery | 标准 CLI(行为不变) |
apisorcery-mcp | MCP 服务器(stdio 传输) |
MCP 服务器暴露三个工具:
| 工具 | 说明 |
|---|---|
generate | 从 Swagger/OpenAPI 规范生成强类型 API 客户端代码,读取当前工作目录下的 .apisorceryrc.json。 |
init | 在当前工作目录创建 .apisorceryrc.json 配置文件。 |
register | 将当前机器注册为 ApiSorcery 账户下的设备。 |
配置步骤
1. 全局安装
shell
npm i @apisorcery/cli -g2. 配置 AI 助手
选择你使用的 AI 编程工具对应的配置方式:
json
// 全局配置:~/.claude/mcp.json
// 项目配置:.mcp.json(放项目根目录,可提交到 git 共享给团队)
{
"mcpServers": {
"apisorcery": {
"command": "apisorcery-mcp"
}
}
}json
// 全局配置:~/.cursor/mcp.json
// 项目配置:.cursor/mcp.json
{
"mcpServers": {
"apisorcery": {
"command": "apisorcery-mcp"
}
}
}json
{
"mcpServers": {
"apisorcery": {
"command": "apisorcery-mcp"
}
}
}json
// 通过 Cline 或 Continue 等 VS Code MCP 扩展配置
// 打开扩展设置 → MCP Servers → 编辑配置文件
{
"mcpServers": {
"apisorcery": {
"command": "apisorcery-mcp"
}
}
}Claude Code 会自动读取项目根目录的 .mcp.json,无需重启。
Cursor 和 Windsurf 修改配置文件后需要重启应用。
工作目录
MCP 服务器会继承启动它的进程的工作目录,请确保它指向项目根目录(即 .apisorceryrc.json 所在位置)。如有需要,可添加 cwd 字段:
json
{
"mcpServers": {
"apisorcery": {
"command": "apisorcery-mcp",
"cwd": "/path/to/your/project"
}
}
}3. 验证服务器已启动
配置完成后,让 AI 助手列出可用工具 — 应该能看到 generate、init、register 三个工具。
使用示例
配置完成后,你可以直接向 AI 助手发起请求:
- "帮我为 Vue 3 TypeScript 项目初始化 ApiSorcery" → 调用
init - "生成 API 客户端" → 调用
generate - "用 token
abc123、备注MacBook注册我的设备" → 调用register
服务器的所有日志输出写入 stderr,stdout 始终用于 MCP JSON-RPC 通信,保持干净。
不全局安装的方式
如不想全局安装,可在配置中使用 npx:
json
{
"mcpServers": {
"apisorcery": {
"command": "npx",
"args": ["-y", "@apisorcery/cli/mcp"]
}
}
}