Skip to content

MCP 接口文档

1. 配置项说明

配置文件:server/config/mcp.php

关键配置:

  • mcp_open:是否开启 MCP 服务
  • route_open:是否开启 MCP 路由(未开启会直接拒绝访问)
  • auth_open:是否开启鉴权
  • auth_token_key:token 存储标识
  • auth_token_expire:token 过期时间(秒)
  • app_map:允许操作的应用模块(如 admin,api

建议在 .env 中显式配置:

env
[mcp]
mcp_open=true
route_open=true
auth_open=true
auth_token_key=admin,api
auth_token_expire=604800
app_map=admin

注意:route_open=false 时,所有 MCP 工具接口不可访问。

2. 统一返回结构

MCP 接口返回遵循统一结构:

json
{
  "code": 0,
  "data": {},
  "msg": "success"
}
  • code = 0:成功
  • code != 0:失败

3. 工具总览

先调用:

  • GET /mcp/tool/tools

该接口返回系统实际可用工具、方法、端点、参数说明。建议所有调用方先拉取该清单再做动态调用。

当前工具主要包括:

  1. requirement_analyzer:需求分析与模块设计
  2. create_dict / get_dict_lists:字典创建与查询
  3. create_menu / get_menu_lists:菜单创建与查询
  4. get_module_info:模块路由/结构信息
  5. create_table:建表工具
  6. tpa_analyze:代码生成前分析
  7. tpa_execute:代码生成执行
  8. tpa_review:代码审查

4. 推荐调用工作流

推荐按以下顺序调用,降低生成错误率:

  1. GET /mcp/tool/tools(拉取可用工具与参数)
  2. POST /mcp/tool/requirement_analyzer(需求结构化)
  3. GET /mcp/tool/module/info(确认模块结构)
  4. GET /mcp/tool/dict/listsGET /mcp/tool/menu/lists(复用现有字典/菜单)
  5. 需要时:POST /mcp/tool/table/createPOST /mcp/tool/dict/create
  6. POST /mcp/tool/gta/analyze
  7. POST /mcp/tool/gta/execute
  8. POST /mcp/tool/gta/review

Released under the Apache-2.0 License.