开放平台

MCP Server

概述

  1. 可以采用符合MCP规范的方式接入柜柜客户端提供的MCP Server

    • 路由:http://127.0.0.1:****

    • 版本:5.0.0.0及以上

  2. 大部分MCP资源/工具需要登录后使用

错误处理

错误码说明

错误码说明
-32001未找到资源
-32002未找到工具
-32003用户未登录
-32602无效参数

错误响应示例

{
    "status": "error",
    "code": -32003,
    "message": "用户未登录",
    "data": "额外的错误信息(可选)"
}

成功响应示例

{
    "status": "success",
    "content": "响应内容",
    "mimeType": "text/plain"
}

使用建议

推荐工作流程

  1. 登录前:可使用 guigui://info/guigui_version 和 guigui://info/login_status 检查应用状态

  2. 获取信息:使用 guigui://info/current_page 确认当前页面,使用 guigui://info/parametric_models 获取可用的参数化模型列表

  3. 创建设计

    • 使用 quick_open_project 打开或创建订单

    • 使用 design_create_model 创建普通模型

  4. 编辑设计

    • 使用 guigui://info/model_structure 获取模型结构,了解组件编号

    • 使用 design_edit_model 编辑模型结构

  5. 保存设计:使用 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"
}

读取资源

参数说明

参数字段必选类型
资源URIuristring

部分资源

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
简要描述
  • 快速打开订单/房间, 如果未找到对应订单/房间, 则创建新订单/房间

  • 需要登录

参数说明
参数字段必选类型说明
设计信息designInfoobject包含项目地址等信息
项目地址designInfo.buyerAddressstring-
房间名designInfo.roomNamestring-
请求示例
{
    "jsonrpc": "2.0",
    "id": 4,
    "method": "tools/call",
    "params": {
        "name": "quick_open_project",
        "arguments": {
            "designInfo": {
                "buyerAddress": "示例地址"
            }
        }
    }
}
design_create_model
简要描述
  • 在设计页面创建模型

  • 需要登录

  • 可通过 guigui://info/parametric_models 资源获取参数化模型列表

参数说明
参数字段必选类型说明
模型类型typestring模型/参数化模型
模型列表modelsarray见参数化模型列表
模型编号models[].idstring-
模型名称models[].namestring-
位置及尺寸models[].cubeobject包含 x, y, z, width, height, depth
X坐标models[].cube.xnumber-
Y坐标models[].cube.ynumber-
Z坐标models[].cube.znumber-
宽度models[].cube.widthnumber-
高度models[].cube.heightnumber-
深度models[].cube.depthnumber-
旋转方式models[].rotatestring向左旋转90度/向左旋转180度/向右旋转90度/向右旋转180度
工艺参数models[].paramsobject见参数化模型工艺参数

参数化模型列表

参数化模型类型参数化模型编号参数化模型名称参数化模型标签
衣柜742361-5门缩放衣柜-
衣柜41361双列开放直柜-
衣柜1245卡槽款式门套-
衣柜679三开门衣柜-
衣柜604门墙柜模型-
书柜81566单列高直柜-
书柜81563直列书桌-
书柜62548简约沙发椅-
书柜58367异型挖空圆弧书柜-
书柜42800L型开放书桌-
书柜36302右圆弧地柜-
书柜36301左圆弧地柜-
橱柜82580L型吊柜-
橱柜82530微波炉吊柜-双门-
橱柜82526L转角地柜-
橱柜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型转角柜-
转角柜645L型转角柜-
单元柜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网红异形单元柜-
异形柜6067字门套-
异形柜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
简要描述
  • 在设计页面预览模型方案

  • 需要登录

参数说明
参数字段必选类型说明
方案列表schemesarray方案列表
方案编号schemes[].idstring-
方案标题schemes[].titlestring-
方案类型schemes[].typestring模型/参数化模型
模型列表schemes[].modelsarray方案包含的模型列表,参见 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
简要描述
  • 在设计页面编辑模型

  • 需要登录

参数说明
参数字段必选类型说明
操作类型operatestring清空房间/应用三方数据
操作参数paramsobject操作参数说明
三方数据格式params.formatstringshcad/guigui
三方数据内容params.contentarray-

操作参数说明

  • 清空房间:不需要传入参数

  • 应用三方数据:format, content

    • 可具体对接

请求示例
{
    "jsonrpc": "2.0",
    "id": 4,
    "method": "tools/call",
    "params": {
        "name": "design_edit_model",
        "arguments": {
            "operate": "清空房间"
        }
    }
}
design_use_design_tool
简要描述
  • 在设计页面操作设计工具

  • 需要登录

参数说明
参数字段必选类型说明
工具名称toolNamestring见工具列表

工具列表

  • 保存、存入模型库、保存历史、转发给好友、同步到知户型、发送到酷家乐

  • 房间锁定、导入酷家乐文件、草图识别、导入CAD图纸

  • 所有孔槽、局部孔槽、更新孔槽

  • 显示标尺、爆炸图、结构图、边缘显示框线、显示板件编号、隐藏颜色显示、封边显示

  • 动画、柜门动画、抽屉动画、柜门、抽屉、未选中、选中

  • 标注、板件备注

  • 撤销、重做、恢复初始状态、复制、粘贴、镜像、删除、均分

  • 审单、补件、切角

请求示例
{
    "jsonrpc": "2.0",
    "id": 4,
    "method": "tools/call",
    "params": {
        "name": "design_use_design_tool",
        "arguments": {
            "toolName": "保存"
        }
    }
}
design_get_room_info
简要描述
  • 在设计页面获取房间信息

  • 需要登录

参数说明
参数字段必选类型说明
信息类型infostring见信息类型列表

信息类型列表

  • 千里眼链接

请求示例
{
    "jsonrpc": "2.0",
    "id": 4,
    "method": "tools/call",
    "params": {
        "name": "design_get_room_info",
        "arguments": {
            "info": "千里眼链接"
        }
    }
}



新格尔累计为
7368555
位用户提供服务

客服热线

联系电话:400-1567-080

微信咨询

扫码在线咨询
企微官网客服在线随时答复

公众号

扫一扫
关注官方公众号

抖音号

扫一扫
关注官方抖音号