Clarion Builder MCP Server

🚀 Clarion Builder MCP Server

A MCP server that provides Clarion development and building capabilities. This server supports automated Clarion IDE operations, project compilation, and build management, utilizing ClarionCL and MSBuild.

🚀 Quick Start

The Clarion Builder MCP Server offers a range of functionalities for Clarion development and building. It simplifies tasks such as project generation, compilation, and template management.

✨ Features

• Execute ClarionCL commands.
• Generate and compile projects.
• Manage templates.
• Import/export dictionaries.
• Handle TXA files.
• Integrate with MSBuild.
• Provide comprehensive build configurations.

🛠️ Tools

ClarionCL Operations

clarion_cl

Execute ClarionCL commands to complete IDE tasks.

• action: The ClarionCL action to be executed (required).
  • Possible values:
    • generate: Generate project files.
    • import-txa: Import TXA files.
    • export-txa: Export TXA files.
    • export-dict: Export dictionaries.
    • import-dict: Import dictionaries.
    • register-template: Register templates.
    • unregister-template: Unregister templates.
    • list-templates: List registered templates.
    • register-driver: Register drivers.
• filePath: The full path of the APP/SLN/TXA/DCT file.
• secondaryPath: The auxiliary path for import/export operations.
• version: The Clarion version to be used (e.g., "Clarion 11.0 Enterprise Edition").
• conditionalGeneration: Enable conditional generation in the generation operation.
• debugGeneration: Enable debug generation in the generation operation.
• useWindowsIdentity: Use Windows authentication.
• templateName: The name of the template.
• driverName: The name of the driver.

Solution Building

compile_solution

Compile a solution.

• solutionPath: The path of the solution file to be compiled.
• configuration: The solution configuration (e.g., "Debug" or "Release").
• platform: The target platform (e.g., "Win32" or "x64").
• generateMap: Enable the generation of mapping files.
• vid: Set the Virtualization Mode (e.g., "full", "none", or "media").
• model: Set the build model (e.g., "Dll" or "Exe").
• copyCoreFiles: Enable the copying of core files.

📦 Installation

1. Clone the repository using Git:

git clone [Repository URL]

2. Install the dependencies:

npm install

⚙️ Configuration

Add the following content to your MCP settings file:

{
  "servers": {
    "clarionBuilder": {
      "type": "ClarionBuilderMCP",
      "url": "http://localhost:3000"
    }
  }
}

💻 Usage Examples

Basic Usage

Generate a Project

await mcp.use("clarion_builder", "generate_project", {
  solutionPath: "./MyApp.sln",
  configuration: "Debug",
  platform: "Win32"
});

Import a TXA File

await mcp.use("clarion_builder", "import_txa", {
  filePath: "./Resources/controls.txa",
  secondaryPath: "./Resources/l10n.xlsx"
});

Compile a Solution

await mcp.use("clarion_builder", "compile_solution", {
  solutionPath: "./MyApp.sln",
  configuration: "Release",
  platform: "x64",
  generateMap: true,
  vid: "full",
  model: "Dll",
  copyCoreFiles: true
});

🛠️ Development

1. Modify the source code.
2. Run the tests:

npm test

3. Build the project:

npm run build

🤝 Contribution

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to the branch.
5. Create a pull request.

📄 License

MIT