README
🚀 Clarion Builder MCP 服务器
Clarion Builder MCP 服务器提供了 Clarion 开发和构建功能。它支持自动化 Clarion IDE 操作、项目编译和构建管理,借助 ClarionCL 和 MSBuild 实现高效开发流程。
🚀 快速开始
Clarion Builder MCP 服务器可助力开发者进行 Clarion 项目的开发与构建。通过自动化操作,能有效提升开发效率。
✨ 主要特性
- 执行 ClarionCL 命令:可执行多种 ClarionCL 命令,实现项目文件生成、TXA 文件和字典的导入导出等操作。
- 生成和编译项目:支持项目的生成与编译,确保项目顺利构建。
- 模板管理:能够对模板进行注册、取消注册和列表查看等操作。
- 字典的导入/导出:方便进行字典数据的管理。
- TXA 文件处理:支持 TXA 文件的导入和导出。
- MSBuild 集成:与 MSBuild 集成,增强构建能力。
- 全面构建配置:提供丰富的构建配置选项,满足不同需求。
📦 安装指南
- 使用 Git 克隆仓库:
git clone [Repository URL]
- 安装依赖项:
npm install
📚 详细文档
工具
ClarionCL 操作
clarion_cl
执行 ClarionCL 命令以完成 IDE 任务。
| 属性 | 详情 |
|------|------|
| action | 要执行的 ClarionCL 行动(必填),取值包括:generate(生成项目文件)、import-txa(导入 TXA 文件)、export-txa(导出 TXA 文件)、export-dict(导出字典)、import-dict(导入字典)、register-template(注册模板)、unregister-template(取消注册模板)、list-templates(列出已注册的模板)、register-driver(注册驱动程序) |
| filePath | APP/SLN/TXA/DCT 文件的完整路径 |
| secondaryPath | 导入/导出操作的辅助路径 |
| version | 要使用的 Clarion 版本(例如,"Clarion 11.0 企业版") |
| conditionalGeneration | 生成操作中启用条件生成 |
| debugGeneration | 生成操作中启用调试生成 |
| useWindowsIdentity | 使用 Windows 身份验证 |
| templateName | 模板的名称 |
| driverName | 驱动程序的名称 |
解决方案构建
compile_solution
编译解决方案。 | 属性 | 详情 | |------|------| | solutionPath | 要编译的解决方案文件的路径 | | configuration | 解决方案配置(例如,"Debug" 或 "Release") | | platform | 目标平台(例如,"Win32" 或 "x64") | | generateMap | 启用生成映射文件 | | vid | 设置 Virtualization Mode(虚拟化模式)(例如,"full"、"none" 或 "media") | | model | 设置构建模型(例如,"Dll" 或 "Exe") | | copyCoreFiles | 启用核心文件的复制 |
配置
将以下内容添加到您的 MCP 设置文件中:
{
"servers": {
"clarionBuilder": {
"type": "ClarionBuilderMCP",
"url": "http://localhost:3000"
}
}
}
💻 使用示例
基础用法
生成项目
await mcp.use("clarion_builder", "generate_project", {
solutionPath: "./MyApp.sln",
configuration: "Debug",
platform: "Win32"
});
导入 TXA 文件
await mcp.use("clarion_builder", "import_txa", {
filePath: "./Resources/controls.txa",
secondaryPath: "./Resources/l10n.xlsx"
});
编译解决方案
await mcp.use("clarion_builder", "compile_solution", {
solutionPath: "./MyApp.sln",
configuration: "Release",
platform: "x64",
generateMap: true,
vid: "full",
model: "Dll",
copyCoreFiles: true
});
🔧 技术细节
开发
- 修改源代码
- 运行测试:
npm test
- 构建项目:
npm run build
贡献
- 叉分仓库
- 创建功能分支
- 提交更改
- 推送到分支
- 创建拉取请求
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫