MCP Server
概述
可以采用符合MCP规范的方式接入柜柜客户端提供的MCP Server
路由:
http://127.0.0.1:****版本:5.0.0.0及以上
大部分MCP资源/工具需要登录后使用
错误处理
错误码说明
| 错误码 | 说明 |
|---|---|
| -32001 | 未找到资源 |
| -32002 | 未找到工具 |
| -32003 | 用户未登录 |
| -32602 | 无效参数 |
错误响应示例
{
"status": "error",
"code": -32003,
"message": "用户未登录",
"data": "额外的错误信息(可选)"
}成功响应示例
{
"status": "success",
"content": "响应内容",
"mimeType": "text/plain"
}使用建议
推荐工作流程
登录前:可使用
guigui://info/guigui_version和guigui://info/login_status检查应用状态获取信息:使用
guigui://info/current_page确认当前页面,使用guigui://info/parametric_models获取可用的参数化模型列表创建设计:
使用
quick_open_project打开或创建订单使用
design_create_model创建普通模型编辑设计:
使用
guigui://info/model_structure获取模型结构,了解组件编号使用
design_edit_model编辑模型结构保存设计:使用
design_use_design_tool工具,选择 “保存” 功能
常见问题
如何获取参数化模型列表?
使用guigui://info/parametric_models资源,返回按类型分组的模型列表如何编辑已创建的模型?
可使用design_edit_model编辑模型结构哪些操作需要登录?
除了guigui://info/guigui_version和guigui://info/login_status外,其他所有资源和工具都需要登录
资源(resources)
查询资源列表
请求示例
{
"jsonrpc": "2.0",
"id": 4,
"method": "resources/list"
}读取资源
参数说明
| 参数 | 字段 | 必选 | 类型 |
|---|---|---|---|
| 资源URI | uri | 是 | string |
部分资源
| URI | 说明 | 需要登录 |
|---|---|---|
| guigui://info/guigui_version | 返回应用版本信息 | 否 |
| guigui://info/login_status | 返回用户登录状态信息 | 否 |
| guigui://info/current_page | 返回当前页面信息 | 是 |
| guigui://info/model_structure | 返回当前模型的模型结构信息 | 是 |
| guigui://info/parametric_models | 返回参数化模型列表信息 | 是 |
请求示例
{
"jsonrpc": "2.0",
"id": 4,
"method": "resources/read",
"params": {
"uri": "guigui://info/guigui_version"
}
}资源说明
可通过
查询资源列表获取最新的资源说明文档中列出的以下内容仅供参考,实际使用时应通过相应接口获取最新信息
推荐做法:每次使用前调用 resources/list 获取最新的资源说明
guigui://info/guigui_version
返回应用版本字符串,例如:"5.0.0.0"
guigui://info/login_status
返回用户登录状态,返回值为 "已登录" 或 "未登录"
guigui://info/current_page
返回当前页面名称,例如:"设计页面"
guigui://info/model_structure
返回当前模型的模型结构信息(JSON格式),包含所有组件的层级结构、编号、类型、尺寸等信息
guigui://info/parametric_models
返回参数化模型列表(JSON格式),按类型分组,包含模型编号、名称、标签等信息。返回格式示例:
{
"衣柜": [
{
"id": "74236",
"name": "1-5门缩放衣柜",
"tag": [
"示例标签"
]
}
],
"书柜": [...],
"橱柜": [...]
}工具(tools)
查询工具列表
请求示例
{
"jsonrpc": "2.0",
"id": 4,
"method": "tools/list"
}调用工具
部分工具
| 工具 | 说明 |
|---|---|
| quick_open_project | 快速打开订单/房间 |
| design_preview_scheme | 在设计页面预览模型方案 |
| design_create_model | 在设计页面创建模型 |
| design_edit_model | 在设计页面编辑模型 |
| design_use_design_tool | 在设计页面操作设计工具 |
| design_get_room_info | 在设计页面获取房间信息 |
工具说明
可通过
查询工具列表获取最新的工具说明文档中列出的以下内容仅供参考,实际使用时应通过相应接口获取最新信息
推荐做法:每次使用前调用 tools/list 获取最新的工具定义和可选参数列表
quick_open_project
简要描述
快速打开订单/房间, 如果未找到对应订单/房间, 则创建新订单/房间
需要登录
参数说明
| 参数 | 字段 | 必选 | 类型 | 说明 |
|---|---|---|---|---|
| 设计信息 | designInfo | 否 | object | 包含项目地址等信息 |
| 项目地址 | designInfo.buyerAddress | 否 | string | - |
| 房间名 | designInfo.roomName | 否 | string | - |
请求示例
{
"jsonrpc": "2.0",
"id": 4,
"method": "tools/call",
"params": {
"name": "quick_open_project",
"arguments": {
"designInfo": {
"buyerAddress": "示例地址"
}
}
}
}design_create_model
简要描述
在设计页面创建模型
需要登录
可通过
guigui://info/parametric_models资源获取参数化模型列表
参数说明
| 参数 | 字段 | 必选 | 类型 | 说明 |
|---|---|---|---|---|
| 模型类型 | type | 否 | string | 模型/参数化模型 |
| 模型列表 | models | 否 | array | 见参数化模型列表 |
| 模型编号 | models[].id | 是 | string | - |
| 模型名称 | models[].name | 否 | string | - |
| 位置及尺寸 | models[].cube | 是 | object | 包含 x, y, z, width, height, depth |
| X坐标 | models[].cube.x | 是 | number | - |
| Y坐标 | models[].cube.y | 是 | number | - |
| Z坐标 | models[].cube.z | 是 | number | - |
| 宽度 | models[].cube.width | 是 | number | - |
| 高度 | models[].cube.height | 是 | number | - |
| 深度 | models[].cube.depth | 是 | number | - |
| 旋转方式 | models[].rotate | 否 | string | 向左旋转90度/向左旋转180度/向右旋转90度/向右旋转180度 |
| 工艺参数 | models[].params | 否 | object | 见参数化模型工艺参数 |
参数化模型列表
| 参数化模型类型 | 参数化模型编号 | 参数化模型名称 | 参数化模型标签 |
|---|---|---|---|
| 衣柜 | 74236 | 1-5门缩放衣柜 | - |
| 衣柜 | 41361 | 双列开放直柜 | - |
| 衣柜 | 1245 | 卡槽款式门套 | - |
| 衣柜 | 679 | 三开门衣柜 | - |
| 衣柜 | 604 | 门墙柜模型 | - |
| 书柜 | 81566 | 单列高直柜 | - |
| 书柜 | 81563 | 直列书桌 | - |
| 书柜 | 62548 | 简约沙发椅 | - |
| 书柜 | 58367 | 异型挖空圆弧书柜 | - |
| 书柜 | 42800 | L型开放书桌 | - |
| 书柜 | 36302 | 右圆弧地柜 | - |
| 书柜 | 36301 | 左圆弧地柜 | - |
| 橱柜 | 82580 | L型吊柜 | - |
| 橱柜 | 82530 | 微波炉吊柜-双门 | - |
| 橱柜 | 82526 | L转角地柜 | - |
| 橱柜 | 82525 | 橱柜地柜 | - |
| 橱柜 | 82524 | 转角吊柜 | - |
| 橱柜 | 82523 | 烟机吊柜 | - |
| 橱柜 | 82522 | 转角橱柜 | - |
| 橱柜 | 82521 | 橱柜抽屉 | - |
| 橱柜 | 82517 | 双上翻门吊柜 | - |
| 橱柜 | 82514 | 单上翻门吊柜 | - |
| 橱柜 | 81564 | 阳台洗手盆柜 | - |
| 橱柜 | 81562 | 吊柜单双开 | - |
| 橱柜 | 36303 | 圆弧吊柜 | - |
| 橱柜 | 29388 | 下开放吊柜-上翻门 | - |
| 橱柜 | 29387 | 单门吊柜 | - |
| 橱柜 | 29385 | 顶板整块-双门烟机吊柜 | - |
| 橱柜 | 13837 | 双开门炉灶地柜 | - |
| 橱柜 | 12688 | 电器炉灶地柜 | - |
| 橱柜 | 12687 | 消毒柜地柜-2 | - |
| 橱柜 | 12686 | 消毒柜地柜-1 | - |
| 桌台 | 81567 | 单列吊柜 | - |
| 桌台 | 48219 | 单抽翻镜梳妆台模型 | - |
| 鞋柜 | 74072 | 翻斗鞋柜模型 | - |
| 玄关柜 | 68688 | 直角转角收纳柜 | - |
| 转角柜 | 82528 | 切角转角双开门接星盆地柜 | - |
| 转角柜 | 82520 | 右L型转角柜 | - |
| 转角柜 | 645 | L型转角柜 | - |
| 单元柜 | 82927 | 电视组合柜 | - |
| 单元柜 | 82926 | 电视柜-带左右储物格 | - |
| 单元柜 | 82925 | 电视中间开放柜 | - |
| 单元柜 | 82924 | 悬空电视柜四抽抽 | - |
| 单元柜 | 82923 | 横向带门储物柜-三对双开 | - |
| 单元柜 | 82922 | 电视上柜 | - |
| 单元柜 | 82921 | 两门电视储物柜 | - |
| 单元柜 | 82920 | 悬空电视柜两抽 | - |
| 单元柜 | 82919 | 悬空电视柜三抽 | - |
| 单元柜 | 82918 | 落地电视柜两抽 | - |
| 单元柜 | 82917 | 落地电视柜三抽 | - |
| 单元柜 | 82687 | 餐边冰箱柜 | - |
| 单元柜 | 82686 | 餐边收纳柜-带抽屉 | - |
| 单元柜 | 82685 | 餐边上柜-带开放格 | - |
| 单元柜 | 82684 | 餐边收纳柜-带开放格上柜 | - |
| 单元柜 | 82683 | 餐边上柜带桌台 | - |
| 单元柜 | 82682 | 餐边收纳柜-带抽屉下柜 | - |
| 单元柜 | 82681 | 三抽两门矮柜 | - |
| 单元柜 | 82680 | 四门矮柜 | - |
| 单元柜 | 82679 | 上电下抽免拉手地柜 | - |
| 单元柜 | 82529 | 切角单假抽双开门地柜 | - |
| 单元柜 | 82527 | 五角切角单开门地柜 | - |
| 单元柜 | 82519 | 双抽地柜-免拉 | - |
| 单元柜 | 82518 | 单抽单开地柜-免拉 | - |
| 单元柜 | 82516 | 圆弧吊柜(1) | - |
| 单元柜 | 82515 | 三抽平分地柜-免拉手 | - |
| 单元柜 | 82513 | 单抽双门底柜-免拉 | - |
| 单元柜 | 81892 | 侧边柜-04-L | - |
| 单元柜 | 81879 | 双列高直柜-05 | - |
| 单元柜 | 81875 | 双区间-TC-003-L | - |
| 单元柜 | 81874 | 三区间-TC-003-L | - |
| 单元柜 | 81873 | 掩门衣柜 | - |
| 单元柜 | 81872 | 单列高直柜-03 | - |
| 单元柜 | 81871 | 侧边柜-01-L | - |
| 单元柜 | 81870 | 四列开门顶柜 | - |
| 单元柜 | 81869 | 三列开门顶柜 | - |
| 单元柜 | 81868 | 双列开门顶柜 | - |
| 单元柜 | 81867 | 掩门衣柜-开放格 | - |
| 单元柜 | 81581 | 单门开放单门高柜 | - |
| 单元柜 | 81580 | 单门开放高柜 | - |
| 单元柜 | 81579 | 单列开放矮柜 | - |
| 单元柜 | 81578 | 单列三抽屉柜 | - |
| 单元柜 | 81577 | 单列双抽屉柜 | - |
| 单元柜 | 81576 | 单列开放层板柜 | - |
| 单元柜 | 81575 | 单列单门直柜 | - |
| 单元柜 | 81574 | 单列单抽直柜 | - |
| 单元柜 | 81573 | 单列开门直柜 | - |
| 单元柜 | 81572 | 单列开门柜 | - |
| 单元柜 | 81571 | 单列开放柜 | - |
| 单元柜 | 81569 | 单列高鞋柜-二断背板 | - |
| 单元柜 | 81568 | 台上柜-断背板有底板 | - |
| 单元柜 | 81565 | 双列矮直柜 | - |
| 单元柜 | 81561 | 直列书桌-右边柜 | - |
| 单元柜 | 81560 | 四列矮直柜 | - |
| 单元柜 | 13354 | 波浪单元柜 | - |
| 单元柜 | 3345 | 厨房双开门地柜B | - |
| 单元柜 | 2958 | 厨房双门转角地柜A | - |
| 单元柜 | 1790 | 衣柜单元吊柜D | - |
| 单元柜 | 1780 | 衣柜单元侧边吊柜 | - |
| 单元柜 | 1770 | 圆弧转角柜 | - |
| 单元柜 | 1763 | 厨房无门柜 | - |
| 单元柜 | 1759 | 厨房烟机吊柜E | - |
| 单元柜 | 1747 | 厨房单开门吊柜D | - |
| 单元柜 | 1744 | 厨房烟机吊柜B | - |
| 单元柜 | 1732 | 厨房双开门吊柜A | - |
| 单元柜 | 1729 | 厨房单开门吊柜C | - |
| 酒柜/餐边柜 | 13991 | 冰箱收纳柜 | - |
| 异形柜 | 22163 | 异形柜 | - |
| 异形柜 | 13355 | 波浪柜 | - |
| 异形柜 | 13055 | 异形楼梯柜 | - |
| 异形柜 | 7732 | 网红异形柜6x6 | - |
| 异形柜 | 7731 | 网红异形单元柜 | - |
| 异形柜 | 606 | 7字门套 | - |
| 异形柜 | 405 | 环形圆弧柜 | - |
| 异形柜 | 402 | 弧形单元柜 | - |
| 门墙柜 | 7736 | 门墙柜公库模型(卡槽海棠角) | - |
| 门墙柜 | 7735 | 门墙柜公库模型(7字) | - |
| 门墙柜 | 7734 | 护墙板(直拼+斜拼) | - |
参数化模型工艺参数
转角柜: 左侧深, 右侧深
单元柜: 板件颜色, 柜门颜色, 抽面颜色
请求示例
{
"jsonrpc": "2.0",
"id": 4,
"method": "tools/call",
"params": {
"name": "design_create_model",
"arguments": {
"models": [
{
"id": "74236",
"name": "1-5门缩放衣柜",
"cube": {
"x": 0,
"y": 0,
"z": 0,
"width": 1000,
"height": 2400,
"depth": 600
},
"params": {
"板件颜色": "白色",
"柜门颜色": "灰色"
}
}
]
}
}
}design_preview_scheme
简要描述
在设计页面预览模型方案
需要登录
参数说明
| 参数 | 字段 | 必选 | 类型 | 说明 |
|---|---|---|---|---|
| 方案列表 | schemes | 否 | array | 方案列表 |
| 方案编号 | schemes[].id | 是 | string | - |
| 方案标题 | schemes[].title | 是 | string | - |
| 方案类型 | schemes[].type | 否 | string | 模型/参数化模型 |
| 模型列表 | schemes[].models | 是 | array | 方案包含的模型列表,参见 design_create_model |
请求示例
{
"jsonrpc": "2.0",
"id": 4,
"method": "tools/call",
"params": {
"name": "design_preview_scheme",
"arguments": {
"schemes": [
{
"id": "scheme1",
"title": "方案1",
"type": "参数化模型",
"models": [
{
"id": "74236",
"name": "1-5门缩放衣柜",
"cube": {
"x": 0,
"y": 0,
"z": 0,
"width": 1000,
"height": 2400,
"depth": 600
}
}
]
}
]
}
}
}design_edit_model
简要描述
在设计页面编辑模型
需要登录
参数说明
| 参数 | 字段 | 必选 | 类型 | 说明 |
|---|---|---|---|---|
| 操作类型 | operate | 是 | string | 清空房间/应用三方数据 |
| 操作参数 | params | 否 | object | 操作参数说明 |
| 三方数据格式 | params.format | 否 | string | shcad/guigui |
| 三方数据内容 | params.content | 否 | array | - |
操作参数说明
清空房间:不需要传入参数
应用三方数据:format, content
可具体对接
请求示例
{
"jsonrpc": "2.0",
"id": 4,
"method": "tools/call",
"params": {
"name": "design_edit_model",
"arguments": {
"operate": "清空房间"
}
}
}design_use_design_tool
简要描述
在设计页面操作设计工具
需要登录
参数说明
| 参数 | 字段 | 必选 | 类型 | 说明 |
|---|---|---|---|---|
| 工具名称 | toolName | 是 | string | 见工具列表 |
工具列表
保存、存入模型库、保存历史、转发给好友、同步到知户型、发送到酷家乐
房间锁定、导入酷家乐文件、草图识别、导入CAD图纸
所有孔槽、局部孔槽、更新孔槽
显示标尺、爆炸图、结构图、边缘显示框线、显示板件编号、隐藏颜色显示、封边显示
动画、柜门动画、抽屉动画、柜门、抽屉、未选中、选中
标注、板件备注
撤销、重做、恢复初始状态、复制、粘贴、镜像、删除、均分
审单、补件、切角
请求示例
{
"jsonrpc": "2.0",
"id": 4,
"method": "tools/call",
"params": {
"name": "design_use_design_tool",
"arguments": {
"toolName": "保存"
}
}
}design_get_room_info
简要描述
在设计页面获取房间信息
需要登录
参数说明
| 参数 | 字段 | 必选 | 类型 | 说明 |
|---|---|---|---|---|
| 信息类型 | info | 是 | string | 见信息类型列表 |
信息类型列表
千里眼链接
请求示例
{
"jsonrpc": "2.0",
"id": 4,
"method": "tools/call",
"params": {
"name": "design_get_room_info",
"arguments": {
"info": "千里眼链接"
}
}
}