gx3-cli-mcp

Local GX Works3 project analysis for engineers and AI agents.

gx3-cli-mcp provides a Windows-first CLI and stdio MCP server for inspecting GX Works3 (.gx3) projects on your own machine. It helps you search devices, comments, cross references, ladder conditions, communication boundaries, and static review signals without modifying the source project.

日本語: GX Works3 (.gx3) プロジェクトをローカルで読み取り解析し、AI エージェントからも使える CLI / MCP サーバーです。プロジェクトを書き換えず、 デバイス、コメント、xref、ラダー根拠、通信境界を確認するための道具です。

This is an unofficial, independent tool. It is not endorsed by Mitsubishi Electric.

What You Can Do

• Find where a device is used and whether it is read, written, or referenced.
• Search device comments such as start, stop, alarm, cycle, step, or manual operation keywords.
• Trace upstream conditions for a coil and print nearby ladder evidence.
• Build xref and SQLite indexes so AI agents can answer from structured facts.
• Review static risks such as duplicate coils, multi-writers, dead logic, and interlock possibilities.
• Inspect external inputs, HMI/communication boundaries, IP maps, link maps, timing candidates, and project-wide summaries.

What It Does Not Do

• It does not include real customer or production PLC projects.
• It does not send project data to an online service by itself.
• It does not provide a GUI in this release.
• It does not require a license token or paid-plan token.
• The MCP server does not expose project-mutating commands.

Install

python -m pip install gx3-cli-mcp
gx3-cli --version
gx3-mcp-server --version

Requires Python 3.10 or later. Installing into a virtual environment is recommended so the two console scripts stay off the system PATH.

If your site blocks PyPI, install the latest source directly:

python -m pip install git+https://github.com/purinzan/gx3-cli-mcp.git

For a local source checkout:

python -m pip install -e .

日本語: 通常は pip install gx3-cli-mcp だけで CLI と MCP サーバーの両方が 入ります。社内プロキシで PyPI に到達できない場合のみ、上の git 直接指定を 使ってください。

First Analysis

Run these three commands first for a real project:

gx3-cli doctor --root C:\path\to\project.gx3
gx3-cli index-lite build --root C:\path\to\project.gx3
gx3-cli xref build --root C:\path\to\project.gx3

Then inspect a device:

gx3-cli query-device M100 --root C:\path\to\project.gx3
gx3-cli xref where-used M100 --root C:\path\to\project.gx3
gx3-cli trace-device M100 --root C:\path\to\project.gx3 --strict-logic --compact

When you pass a .gx3 file, the tool extracts it into .gx3_cache\<sha256>\ and analyzes that local cache.

Common Tasks

Use the indexed commands above for normal lookup and discovery. Avoid starting AI workflows with raw text search over extracted GX3 files; GX Works3 projects contain binary/database files, and the CLI preserves device, comment, POU, role, and step context.

Use With MCP

The MCP server is intended for AI clients that support stdio MCP servers.

{
  "mcpServers": {
    "gx3": {
      "command": "python",
      "args": ["-m", "gx3cli.gx3_mcp_server"]
    }
  }
}

If your client can resolve console scripts from PATH:

{
  "mcpServers": {
    "gx3": {
      "command": "gx3-mcp-server"
    }
  }
}

The MCP server exposes read-only analysis tools and a restricted command runner. Synthetic demo generation is local CLI-only.

Demo Project

Use a synthetic project for screenshots, tutorials, and first-time tests.

gx3-cli synthetic-project demo.gx3 --overwrite
gx3-cli doctor --root demo.gx3
gx3-cli trace-device M100 --root demo.gx3 --strict-logic --compact

For a project with enough in it to be worth exploring, use the demo-line profile: a 14-station pick-and-place line, about 500 rungs across 10 programs with roughly 500 commented devices, chained so that tracing an output on the last station walks back through every station upstream.

gx3-cli synthetic-project line.gx3 --profile demo-line --overwrite
gx3-cli index-lite build --root line.gx3
gx3-cli xref build --root line.gx3
gx3-cli lint line.gx3
gx3-cli dead-logic --root line.gx3

It also contains a small number of deliberate faults - a duplicate coil, a latch with no reset, a coil nobody reads, a contact that can never close, and two devices whose comments contradict each other - so the review commands report findings instead of an empty table. This is also the fastest way to reproduce a bug for an issue without sending anyone a real project.

Data And Safety

• Project files stay on your machine unless you pass outputs to another tool.
• Some commands create local files such as SQLite indexes, CSV reports, ZIP support bundles, or Markdown summaries.
• Analysis output is advisory. Verify findings in GX Works3 and through your own safety/quality process before changing real equipment.
• The tool is not a substitute for PLC validation, machine safety review, or official engineering software.

Documentation

Recommended reading:

1. User manual (JA): Japanese install and usage guide.
2. Agent usage guide (JA): how AI agents should use the indexed tools.
3. Security note (JA): local data handling and read-only MCP policy.
4. Validation matrix (JA): verified scope and limitations.
5. File usage guide (JA): repository file map for agents and contributors.

MCP configuration examples:

• MCP client config: robust python -m gx3cli.gx3_mcp_server launch.
• MCP client config, console script: direct gx3-mcp-server launch when PATH is reliable.

License In Plain Words

Full terms are in LICENSE.txt; this section is only a summary and the license text governs.

This is source-available proprietary software, not open source. In practice:

• You may clone it, read the source, and run it for evaluation and for internal analysis work, including inside a company.
• You may not redistribute it, host it as a service, resell it, or ship it as part of a paid product or commercial service without written permission.
• There is no license token, activation, or paid plan to run it.
• It is provided as is, with no warranty, and its output is advisory only.

日本語: 社内での評価・業務利用は許諾されています。禁止しているのは再配布、 SaaS としての提供、有償製品やサービスへの組み込みです。実行にライセンス キーや課金は不要です。商用利用の相談は Issue からご連絡ください。

For Contributors

Bug reports, questions, and small pull requests are welcome, in Japanese or English. Start with CONTRIBUTING.md, which covers the no-project-data rule, the development setup, and what a useful bug report contains. Issues labeled good first issue are scoped to be approachable without deep knowledge of the GX Works3 file format.

Before changing or publishing this project, run the same checks used by CI:

python run_tests.py
python scripts\release_gate.py .
python -m build --wheel
python scripts\release_gate.py dist\gx3_cli_mcp-*.whl