Getting started

Use this document for local setup and execution only.

Requirements

  • Python 3.12+
  • uv
  • openplc-cli on PATH when using compile_project
  • Node.js/npm only when using MCP Inspector through mcp dev

The headless OpenPLC CLI used by compile_project() was merged into the OpenPLC Editor development branch on August 24, 2026 (PR #1026) and is newer than the latest published Editor release v4.2.11. See openplc-projects.md for the complete compatibility boundary.

Install

git clone https://github.com/industrix-com-br/openplc-engineering-mcp.git
cd openplc-engineering-mcp
uv sync

Run the MCP server

The package exposes the openplc-engineering-mcp console script and uses stdio transport.

uv run openplc-engineering-mcp

Open with MCP Inspector

uv run mcp dev src/openplc_engineering_mcp/server.py --with-editable .

Verify the project

uv run pytest
uv run ruff check .
uv run pyright

For test conventions and development rules, continue with development.md.