操作指南
完成连接后,AI 将获得 Apipost 资产的可读 + 可写能力。它不再只是代码生成器,而是可以直接进入你的项目空间,执行:
- 项目结构读取
- 接口检索与定位
- 文档与接口创建/修改
- 环境与模型联动分析
本篇目标:3 分钟掌握 MCP 的核心操作链路
2.1 项目认知:让 AI 先“看懂你的仓库”
在任何操作之前,必须先建立“上下文”。
① 获取项目结构
用途:初始化 AI 的项目认知(强制建议第一步执行)
指令示例:
“同步我的项目结构”
“列出我当前可访问的项目”
AI 行为:
返回项目列表,包含:项目名称 / 项目 ID / 权限范围。作为后续所有操作的“唯一定位依据”
没有 project_id,后续所有操作都不可靠
② 全局检索资产
用途:跨目录、跨层级搜索接口/文档/目录
指令示例:
“搜索包含‘用户’的接口”
“查找 path 包含 /v1/order 的接口”
AI 行为:
穿透目录结构,返回:HTTP 接口|文档|目录节点,保留层级关系(父子路径)
2.2 接口资产管理:CRUD 统一入口
这一部分是 MCP 的核心生产力区。
① 创建 / 导入接口
(结构化创建)指令示例
“在订单模块创建一个取消订单接口”
“新建一个 GET 用户详情接口”
AI 行为
自动归类到目标目录,生成标准 HTTP 节点,补齐基础结构(method / path / params)
(批量 Swagger 导入)指令示例
“导入这份 Swagger 3.0 定义”
AI 行为
解析 Swagger;自动生成接口树结构;保持字段映射一致性
② 查询接口详情
用途:获取“真实定义”,不是猜测
指令示例
“给我看登录接口的完整结构”
“查看支付接口文档”
AI 行为
按类型返回:HTTP:参数 / headers / body / response;文档:Markdown 原文;目录:公共配置
③ 批量清理
指令示例
“删除所有测试接口”
“清理废弃文档”
AI 行为
支持批量匹配;基于名称 / path / 类型过滤;执行不可逆删除操作
2.3 联调能力:环境 + 模型驱动
这一层解决的是“接口能不能用对”的问题。
① 环境变量
指令示例
“当前环境 baseURL 是什么?”
“列出 staging 环境配置”
AI 行为
返回环境变量;Base URL;环境级配置(token / host)
② 全局参数
指令示例
“全局请求头有哪些?”
AI 行为
返回统一 header / auth / 公共参数;用于统一联调标准
③ 数据模型驱动(search_model)
关键价值:避免“猜字段”
指令示例
“查 UserInfo 模型,并生成 TS 类型”
AI 行为
返回 schema 定义;字段级精确结构;可直接用于 TypeScript interface 前端 DTO mock 数据生成
2.4 标准工作流(推荐使用方式)
建议按“认知 → 定位 → 使用”三段式执行:
Step 1:初始化上下文 “同步项目树”
Step 2:定位目标 “查找订单相关接口”
Step 3:使用结构 “根据接口定义生成前端调用代码”
2.5 常见问题(FAQ)
| 现象 | 可能原因 | 解决方案 |
|---|---|---|
| AI 提示找不到新项目 | 上下文未及时同步 | 对 AI 说:“重新刷新我的项目列表” |
| 参数感觉没对上 | 存在多级继承逻辑 | 查看 get_target_detail |
| 导入失败 | Swagger 非标准 | 目前主要支持标准 Swagger 3.0 规范 |
MCP 的本质
MCP 不是“AI 操作工具”,而是:把 API 资产从“文档系统”升级为“可执行的工作空间”。
建议使用方式**
🚫 不要直接问:“怎么写接口?”
✅ 应该问:“系统里有没有类似接口?”、“当前环境怎么配置?”、“这个模型标准是什么?”