- 版本校验:基座侧改用编译期常量 (ARX<<16)|SUB_ARX,不再调用运行时的 acrxGetApiVersion()。该函数由 rxapi.lib 的 acrxGetApiVersionImpl 提供, 是有状态实现(读写进程内全局),返回值随调用次数变化;AutoCAD 加载 ARX 时已调用过一次,导致基座值与 DLL 值不等,绝大多数 DLL 工具被拒绝注册。 - 新增 DLL 模块缓存:同一 DLL 全进程只 LoadLibrary 一次,后续工具复用句柄 并跳过版本校验。 - 文档锁:mcp_Tool_DllProxy::Execute 统一 lockDocument/unlockDocument, 修复 DLL 工具在 AutoCAD 应用上下文写数据库返回 eLockViolation (表现为 openWriteSpace 拿不到模型空间)的问题。 - 代理类不再 FreeLibrary 模块(改由模块缓存统一卸载),避免同一 DLL 的多个 工具重复释放、引用计数被打穿。 - 诊断日志精简为仅记录 arx_version/dll_version,且每次加载清空重写。 - 新增 verify_annotate.py:批注工具集运行时验证脚本(绘制/校验/改属性/清理)。
7.9 KiB
CODEBUDDY.md
This file provides guidance to CodeBuddy Code when working with code in this repository.
项目概述
CADProject 是一个将 AutoCAD / 中望 CAD (ZWCAD) 变为 MCP (Model Context Protocol) 服务端的插件工程。CAD 进程内运行一个 TCP JSON-RPC 服务,向大模型暴露 tools/list 与 tools/call,让 LLM 能驱动 CAD 执行绘图、缩放、截图等操作。仓库同时附带一组 Python 客户端脚本用于联调。
构建
构建系统为 CMake + vcpkg + Visual Studio 生成器,通过 CMake Presets 区分 CAD 版本。产物输出到 bin/<Config>-<TAG>/ 与 lib/<Config>-<TAG>/。
# 配置 + 构建单个版本(以 R243 为例)
cmake --preset R243
cmake --build --preset R243 --config Release
# 或使用根目录脚本批量处理(内部即上面两条命令的组合)
./preset.bat # 仅 configure: R190 / R230 / R220
./build.bat # build --config release: R230 / R220
- 前置环境:需要
VCPKG_ROOT环境变量;第三方 CAD SDK 位于仓库同级的../envi-code/Arx(AutoCAD)与../envi-code/Zrx(ZWCAD),路径在cmakepresets.json的CAD_SDK_ROOT中配置。 - 可用 preset:
R180–R260(AutoCAD,ARX 18–26)、Z2023–Z2026(ZWCAD,ZRX)。每个 preset 绑定对应的 MSVC toolset(v90–v143)。preset 名称同时决定输出目录标签GENERATE_DIR_TAG(如R243、Z2024)。 - 必需 cache 变量(缺失会
FATAL_ERROR):CAD_SDK_ROOT、DEP_LIB_ROOT、DEP_INC_ROOT、CAD_SDK_VERSION,AutoCAD 版还需CAD_SDK_SUBVERSION。 - vcpkg 依赖见
vcpkg.json:nlohmann-json、curl、ghc-filesystem;triplet 为x64-windows-static-md(静态库 + 动态 CRT,定义于cmake/x64-windows-static-md.cmake)。
测试
工程内没有单元测试框架。所谓“测试”是根目录下的 Python 脚本,它们是 MCP 客户端的联调工具,必须先启动已加载插件的 CAD,并确认 8080 端口在监听:
python test.py # 最小示例:截图 -> 发给 DeepSeek 视觉模型 -> 回答
python test_autoagent.py # 仅拉取一次视口截图并保存为 test_screenshot.png
python countOfCircle.py # 伪造一次 zoom_window_normalized 调用,验证 TCP 链路
python agent_loop.py # 完整 Agent 循环(多回合 截图/缩放/结论),需 openai 包与 API Key
脚本通过 TCP 连接 127.0.0.1:8080 收发 JSON-RPC。agent_loop.py / test.py 中硬编码了 DeepSeek API Key 与模型名,属于调试脚本。
架构
两个构建目标
| 目标 | 产物 | 作用 |
|---|---|---|
src/cad_mcp_frame |
cad_mcp_frame.arx(ZWCAD 下为 .zrx) |
MCP 基座。随 CAD 加载,起 TCP 服务、解析工具配置、路由执行。 |
src/cad_mcp_plugins |
cad_mcp_plugins.dll |
示例 C++ 工具插件,通过 ABI 被基座动态加载。 |
基座运行模型(src/cad_mcp_frame/)
- CAD 加载
.arx→acrxEntryPoint(kInitAppMsg)→mcp::init_mcp_server()(cad_mcp_frame.cpp:41)。 init_mcp_server()(mcp_server.cpp:225)在主 UI 线程创建仅消息窗口(HWND_MESSAGE,McpWndProc),并启动后台TcpServerLoop线程监听127.0.0.1:8080。- 跨线程安全是核心设计:TCP 线程只负责
recv,把请求封装成TaskData(含 socket)后PostMessage(WM_MCP_EXECUTE_TASK)投递给消息窗口。真正的工具执行ExecuteTaskInMainThread()运行在 CAD 主线程,从而安全调用 ARX API。执行结果再通过该 socket 发回。 - 配置加载:
mcp_ConfigParser::LoadAndRegister()读取模块所在目录下的mcp_config.json(getModelDirPath(),即.arx同级目录),按tools[].backend.type注册工具到全局mcp_Tools注册表(unordered_map<name, shared_ptr<mcp_Tool>>)。 - 卸载:
close_mcp_server()停线程、销毁消息窗口、清空工具表。
支持的 JSON-RPC 方法:tools/list(返回所有工具描述)、tools/call(路由到 mcp_Tools::Call)。非法 JSON 返回 -32700,未知方法返回 -32601。
三种工具后端(backend.type)
lisp_inline:把script_template中的{占位符}替换为调用参数,sendStringToExecute到命令行(异步)。布尔值转T/nil。见mcp_tool.cpp:43。lisp_file:先(load "文件" nil)再执行call_template,file_name相对于配置中的lisp_directory解析。见mcp_tool.cpp:61。c++_dll:LoadLibrary第三方 DLL。同一 DLL 全进程只加载一次(句柄由mcp_configParser.cpp的模块缓存g_loadedDllModules持有,mcp_Tools::clear()时统一FreeLibrary),仅首次加载时校验 ARX 大版本:用编译期常量(ARX<<16)|SUB_ARX与 DLL 导出的acrxGetApiVersion比对,不匹配则拒绝加载防崩溃。注意运行时的acrxGetApiVersion(rxapi.lib的acrxGetApiVersionImpl)是有状态实现,返回值会随调用次数变化,不能用作基座侧版本。取factory_function与Destroy_<factory>创建/销毁工具,用mcp_Tool_DllProxy托管工具对象生命周期(RAII,不再 FreeLibrary 模块)。跨 DLL 通过SetConfigAbiSafe/ExecuteAbiSafe传 C 字符串,JSON 序列化全部在 DLL 内部完成。见mcp_configParser.cpp、mcp_tool.cpp。
插件 ABI(inc/mcp_plugin_api.h)
第三方工具只需继承 mcp_Tool,实现纯虚 Execute(args),并用 EXPORT_MCP_TOOL(ToolClass, FactoryName) 宏导出工厂 + 销毁函数。mcp_Tool_Utility 提供 make_text_result / make_image_result / make_mixed_result / make_error 等返回体构造器。mcp_plugins.cpp 中的 mcp_Tool_ViewportScreenshot(GDI+ 抓屏 → PNG → Base64 → 多模态返回)是完整参考实现。
关键头文件
inc/cadsdk.h:ARX 开发总伞头文件,一次性引入几乎所有 ObjectARX/ZWCAD 头文件,处理 ZWCAD 与 AutoCAD 的宏/库差异。业务.cpp通常只需#include "cadsdk.h"。src/cad_mcp_frame/StdAfx.h:预编译头(MFC + Windows),是cad_mcp_frame的 PCH 入口。
配置与产物布局
- 运行时配置:
mcp_config.json,必须与.arx同目录。示例见bin/Debug-R230/mcp_config.json(含zoom_window_normalized、zoom_extents、get_viewport_screenshot三个工具);src/cad_mcp_frame/cad-mcp-frame.json是模板(文件名带连字符,非运行时文件)。 global_settings.plugin_directory指向 C++ DLL 目录,lisp_directory指向 LISP 目录(默认都相对模块目录)。示例 LISP 见bin/Debug-R230/mcp_plugins/mcp_table_array.lsp。cmake/functions.cmake提供工程级封装:target_link_objectarx(自动按 ZWCAD 与否链接ThirdParty::ZRX/ThirdParty::ARX、注入ARX/SUB_ARX宏)、target_set_name_and_suffix(.arx在 ZWCAD 下自动变.zrx)、add_def_file_name、set_debug_post_build等。新增目标应复用这些函数而非手写链接。cmake/ThirdPartyDeps.cmake注册所有ThirdParty::*INTERFACE 目标(ARX/ZRX/cURL/SQLite3/BitAnswer/modernGlue/CadOcr)。
约定与注意点
- 不要改动线程模型:任何涉及 ARX API 的工具逻辑必须在主线程(
ExecuteTaskInMainThread派发链)中执行,不能在TcpServerLoop线程里直接调用。 - C++ 标准随 SDK 版本浮动:
cmakelists.txt按CAD_SDK_VERSION自动设定 C++98/03/14/20,跨版本改动需兼容旧标准(低版本 SDK 最高只到 C++14)。 - 新增 CAD 版本支持时,需在
cmakepresets.json同步添加configurePresets与buildPresets,并在cmake/ThirdPartyDeps.cmake中确认对应库列表(如CAD_SDK_VERSION GREATER 23时追加acpal.lib/acgeoment.lib)。 bin/、lib/、out/均为构建产物,已在.gitignore中忽略;源码在src/、inc/、cmake/。