CODESYS MCP Server

Ein Model Context Protocol Server für das CODESYS Development System V3. Er bietet MCP-Clients kuratierte CODESYS-Anleitungen, Hilfe beim Schreiben von Structured Text, durchsuchbare lokale PDF-Dokumentationen und optional die Live-Abfrage von zugelassenen offiziellen CODESYS-Seiten.

Der Server kann über HTTP unter /mcp oder über stdio für die direkte CLI- und Agenten-Integration ausgeführt werden. Offizielle Seiten werden zusammengefasst und zitiert, anstatt sie in das Projekt zu kopieren. Zu den primären offiziellen Quellen gehören die CODESYS Online Help und CODESYS Examples.

Tools

• search_codesys_docs: Durchsucht kuratierte und/oder offizielle CODESYS-Anleitungen.

• get_codesys_topic: Erklärt ein bekanntes Thema wie POUs, Funktionsbausteine, Timer, Tasks, Variablen, Bibliotheken, Debugging oder Structured Text.

• codesys_writing_guidance: Bietet praktische Anleitungen für CODESYS- und Structured Text-Design für eine angeforderte Aufgabe.

• list_codesys_pdfs: Listet PDF-Dokumente auf, die im konfigurierten PDF-Ordner verfügbar sind.

• search_codesys_pdfs: Durchsucht Text, der aus lokalen PDF-Dokumenten extrahiert wurde.

• get_codesys_pdf: Gibt extrahierten Text aus einem bestimmten lokalen PDF-Dokument zurück.

• get_codesys_page: Ruft den vollständigen Textinhalt einer beliebigen zugelassenen CODESYS-Dokumentations-URL ab.

• crawl_codesys_help: Durchsucht und indiziert die CODESYS-Hilfeseite für durchsuchbare Dokumentation.

Related MCP server: mql5-help-mcp

Was er tut

• Durchsucht kuratierte CODESYS-Anleitungen nach Konzepten, Syntax und Workflow-Hilfe.

• Erklärt gängige CODESYS-Themen wie POUs, Funktionsbausteine, Timer, Tasks, Variablen, Bibliotheken, Debugging und Structured Text.

• Bietet praktische Anleitungen für Structured Text und Projektstruktur.

• Durchsucht lokale PDF-Handbücher und Notizen, die in docs/pdfs/ abgelegt sind.

• Ruft zugelassene offizielle CODESYS-Dokumentationsseiten ab und fasst diese zusammen.

• Durchsucht die offizielle Hilfeseite, um einen durchsuchbaren Index zu erstellen.

Installation für Benutzer

Verwenden Sie dies, wenn Sie den Server selbst auf Ihrem Computer ausführen möchten.

Voraussetzungen:

• Node.js 20 oder neuer

• npm

Von einem frischen Klon:

npm install
cp .env.example .env
npm run build

Starten Sie den HTTP-Server:

npm start

Oder starten Sie den stdio-Server:

npm run start:stdio

Standardmäßig lauscht der HTTP-Server auf http://0.0.0.0:3000/mcp.

Installation für eine KI oder einen Agenten

KI-Agent? Lesen Sie agent.md — es enthält die vollständige, schrittweise Selbstinstallationsanleitung, die speziell für Sie geschrieben wurde. Beginnen Sie dort.

Verwenden Sie diesen Abschnitt, wenn eine KI angewiesen wird, sich selbst als MCP-Client mit dem Server zu verbinden.

Empfohlene Anweisung für die KI:

Read agent.md in the repository root. It contains the exact steps to install this MCP server into yourself.

1. Erstellen Sie zuerst das Projekt:

npm install
npm run build

2. Bevorzugen Sie den stdio-Transport für die lokale Agenten-Integration.

3. Fügen Sie den Server unter Verwendung der lokalen Build-Ausgabe zum Client hinzu:

claude mcp add --transport stdio codesys-docs -- node ./dist/src/cli.js --stdio

4. Wenn der Client stattdessen HTTP benötigt, starten Sie den Server und registrieren Sie den Endpunkt:

npm start

claude mcp add --transport http codesys-docs http://localhost:3000/mcp

5. Wenn der Agent nur mit einem veröffentlichten Paket arbeiten kann, verwenden Sie:

claude mcp add --transport stdio codesys-docs -- npx -y codesys-mcp-server --stdio

Für Codex CLI:

codex mcp add codesys-docs -- node ./dist/src/cli.js --stdio

Schnellstart

npm install
cp .env.example .env
npm run build
npm start

Der Server lauscht standardmäßig auf http://0.0.0.0:3000/mcp.

Docker

docker compose up --build

Die Compose-Datei bindet ./docs/pdfs schreibgeschützt in den Container ein, sodass Sie lokal PDFs hinzufügen können, ohne das Image neu zu erstellen.

PDF-Ordner

Legen Sie CODESYS-Handbücher, Hersteller-PDFs, Projektnotizen, Datenblätter oder exportierte Dokumentationen in folgenden Ordner:

docs/pdfs/

Der MCP-Server extrahiert Text aus .pdf-Dateien in diesem Ordner und stellt sie über folgende Funktionen zur Verfügung:

• search_codesys_docs mit sourceMode: "pdf" oder sourceMode: "all"

• list_codesys_pdfs

• search_codesys_pdfs

• get_codesys_pdf

Die PDF-Textextraktion funktioniert am besten bei durchsuchbaren Text-PDFs. Gescannte, reine Bild-PDFs liefern möglicherweise wenig oder gar keinen Inhalt, sofern keine OCR angewendet wurde. Extrahierter Text kann Diagramme, Screenshots, Formatierungen und einige Tabellen auslassen, daher sollten wichtige technische Details anhand des Original-PDFs überprüft werden.

Konfiguration

CLI-Nutzung

# HTTP server (default)
node dist/src/cli.js
npm start

# Stdio server (for Claude Code / Codex CLI MCP integration)
node dist/src/cli.js --stdio
npm run start:stdio

Akzeptanzprüfungen

npm test
npm run build
curl http://localhost:3000/healthz