Clarion Builder

You can automate Clarion IDE tasks, project generation and building, and manage templates and dictionaries using an MCP server built for Clarion development. This server enables you to run ClarionCL actions, compile solutions with MSBuild, and control TXA handling and dictionary operations from a centralized MCP workflow.

How to use

To use this MCP server with your MCP client, connect using a stdio server configuration and invoke actions through the clarion_cl endpoint to perform IDE tasks, project generation, or build operations. You can generate projects, import or export TXA files, manage dictionaries and templates, and then compile full solutions as part of your automated build pipeline.

How to install

# Step 1: Clone the project
git clone https://github.com/yourusername/clarion-builder-mcp-server.git
cd clarion-builder-mcp-server

# Step 2: Install dependencies
npm install

# Step 3: Build the project
npm run build

Configuration

Add the server to your MCP settings file using the following example. This config starts the server via Node and points to the built index. If you run in a different environment, adjust the path to the compiled index accordingly.

{
  "mcpServers": {
    "clarion_builder": {
      "command": "node",
      "args": ["path/to/clarion-builder-mcp-server/dist/index.js"],
      "env": {}
    }
  }
}

Usage examples

These examples show how to perform common tasks from your MCP client using the clarion_builder server.

// Generate a Clarion project
await mcp.use("clarion_builder", "clarion_cl", {
  action: "generate",
  filePath: "./src/MyApp.app",
  version: "Clarion 11.0 Enterprise Edition",
  conditionalGeneration: true,
  useWindowsRedirection: true,
  redirectionFile: "Clarion110.red"
});

// Export TXA
await mcp.use("clarion_builder", "clarion_cl", {
  action: "export-txa",
  filePath: "./src/MyApp.app",
  secondaryPath: "./backup/MyApp.txa",
  useWindowsRedirection: true,
  redirectionFile: "Clarion110.red"
});

// Import TXA
await mcp.use("clarion_builder", "clarion_cl", {
  action: "import-txa",
  filePath: "./src/MyApp.app",
  secondaryPath: "./backup/MyApp.txa",
  useWindowsRedirection: true,
  redirectionFile: "Clarion110.red"
});

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

Available tools

clarion_cl

Executes ClarionCL commands for IDE tasks such as generate, import-txa, export-txa, export-dict, import-dict, register-template, unregister-template, list-templates, and template-related actions.

compile_solution

Compiles a Clarion solution with MSBuild, supporting configuration, platform, and various build options like lineNumbers, MAP file generation, and core file copying.