Sysbuilder MCP Server

Sysbuilder MCP Server 用于把 Sysbuilder 对外开放的 Python API 封装成 MCP tools，供 Codex、Claude Code 以及其他支持 MCP 的客户端调用。

目录结构

在当前目录执行：

.\install_mcp.ps1

脚本会提示输入 Sysbuilder 安装目录或 Sysbuilder.exe 路径，然后自动写入 MCP 客户端配置。
如果 Sysbuilder 目录下没有自带 Python，也可以显式指定：

.\install_mcp.ps1 -PythonPath E:\Python311\python.exe

当前会处理这些配置文件：

安装脚本还会在当前目录生成一份通用示例：

mcp_server_config.json

当前服务提供 9 个核心工具，聚焦 Sysbuilder 的模型构建、需求导入、模型生成及文档导出，支撑复杂系统设计建模。

从用途上看，这些工具可以分为以下 4 类。

工具英文名	工具中文描述	工具具体功能描述
`start`	启动 Sysbuilder 工具	用于启动 Sysbuilder 并建立脚本连接。可直接传入 `process_path` 指向 `Sysbuilder.exe`，也可依赖安装脚本写入的默认路径。它通常是显式会话管理场景的第一步；在大多数建模工具调用里，服务也会自动尝试启动或连接。
`find`	查找会话工具	用于发现当前可连接的 Sysbuilder 实例及端口信息。适合排查 MCP 服务已启动但尚未附着到目标 Sysbuilder 进程时的连接问题，也可用于多实例场景下确定可用端口。
`connect`	连接 Sysbuilder 工具	用于连接已启动的 Sysbuilder 实例。若未显式传入 `port`，会优先查找可连接实例并自动选择第一个可用端口，适合在手工启动了 Sysbuilder 之后再接入 MCP 服务。
`exit`	关闭 Sysbuilder 工具	用于调用底层 `Exit()` 关闭当前已连接的 Sysbuilder。这个工具只处理已建立连接的会话，不会在未连接时隐式启动或连接软件，适合在批处理完成后主动释放建模会话。

工具英文名	工具中文描述	工具具体功能描述
`run_script`	建模脚本执行工具	用于执行完整的 Sysbuilder Python 建模脚本，是自动化建模、需求建模、功能建模、架构建模、关系创建、视图生成等任务的核心入口。该工具只负责执行现成脚本；大模型根据自然语言，应先生成完整建模脚本，再把脚本文本或脚本路径传给它执行建模操作。

工具英文名	工具中文描述	工具具体功能描述
`import_model`	模型导入工具	用于将外部需求或模型文件导入到 Sysbuilder，当前支持需求 Excel、ReqIF 和 XML。可通过 `import_type=auto` 自动识别，也可显式指定导入类型，适合承担需求基线导入、第三方需求交换和既有模型迁移等任务。

工具英文名	工具中文描述	工具具体功能描述
`generate_modelica_framework`	Modelica 框架生成工具	用于调用 `GenerateModelicaSimulationFramework`，根据目标元素的完整名称生成 Modelica 仿真框架。适合在 SysML 模型已经具备一定结构后，向仿真侧继续推进模型落地和接口衔接。
`generate_system_design_report`	系统设计报告生成工具	用于调用 `GenerateSystemDesignReport`，按 Sysbuilder 内置固定模板直接生成系统方案设计报告。适合在需求、结构和关系模型相对稳定后，快速输出正式设计报告用于评审、归档和方案沟通。
`generate_geometric_param_doc`	几何参数文档生成工具	用于调用 `GenGeometricParam`，从模块定义图中提取目标模块的几何参数并生成 Markdown 文档。适合在结构模型稳定后输出参数说明和设计接口说明，并为后续 CAD 模型提供几何参数输入。

本项目基于 MIT License 发布，详见根目录下的 LICENSE。