CODESYS MCP Server

CODESYS Development System V3用のModel Context Protocolサーバーです。MCPクライアントに対し、厳選されたCODESYSガイダンス、構造化テキストの記述支援、検索可能なローカルPDFドキュメント、および許可リストに基づいた公式CODESYSページのライブ検索機能を提供します。

このサーバーは、HTTP（/mcp）またはstdioを介して動作し、CLIやエージェントとの直接統合が可能です。公式ページは、プロジェクトにコピーされるのではなく、要約および引用されます。主な公式ソースには、CODESYS Online HelpやCODESYS Examplesが含まれます。

ツール

• search_codesys_docs: 厳選された、または公式のCODESYSガイダンスを検索します。

• get_codesys_topic: POU、ファンクションブロック、タイマー、タスク、変数、ライブラリ、デバッグ、構造化テキストなどの既知のトピックを解説します。

• codesys_writing_guidance: 要求されたタスクに対して、実践的なCODESYSおよび構造化テキストの設計ガイダンスを提供します。

• list_codesys_pdfs: 設定されたPDFフォルダー内のPDFドキュメントを一覧表示します。

• search_codesys_pdfs: ローカルのPDFドキュメントから抽出されたテキストを検索します。

• get_codesys_pdf: 特定のローカルPDFドキュメントから抽出されたテキストを返します。

• get_codesys_page: 許可リストに含まれるCODESYSドキュメントURLの全文を取得します。

• crawl_codesys_help: CODESYSヘルプサイトをクロールし、検索可能なドキュメントとしてインデックス化します。

Related MCP server: mql5-help-mcp

機能

• 概念、構文、ワークフローに関する厳選されたCODESYSガイダンスの検索。

• POU、ファンクションブロック、タイマー、タスク、変数、ライブラリ、デバッグ、構造化テキストなどの一般的なCODESYSトピックの解説。

• 実践的な構造化テキストおよびプロジェクト構造に関するガイダンスの提供。

• docs/pdfs/に配置されたローカルPDFマニュアルやメモの検索。

• 許可リストに含まれる公式CODESYSドキュメントページの取得と要約。

• 公式ヘルプサイトをクロールして検索可能なインデックスを構築。

ユーザー向けインストール手順

ご自身のマシンでサーバーを実行したい場合に使用してください。

前提条件:

• Node.js 20以降

• npm

新規クローンから:

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

HTTPサーバーの起動:

npm start

またはstdioサーバーの起動:

npm run start:stdio

デフォルトでは、HTTPサーバーはhttp://0.0.0.0:3000/mcpでリッスンします。

LLMまたはエージェント向けインストール手順

AIエージェントですか？ agent.mdを読んでください。そこには、あなた専用に書かれた完全なステップバイステップの自己インストールガイドが含まれています。まずはそこから始めてください。

LLMがMCPクライアントとしてサーバーに接続するように指示されている場合、このセクションを使用してください。

LLMに与える推奨指示:

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

1. まずプロジェクトをビルドします:

npm install
npm run build

2. ローカルエージェントとの統合にはstdioトランスポートを推奨します。

3. ローカルビルドの出力を使用して、クライアントにサーバーを追加します:

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

4. クライアントがHTTPを必要とする場合は、サーバーを起動してエンドポイントを登録します:

npm start

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

5. エージェントが公開パッケージからのみ動作可能な場合は、以下を使用します:

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

Codex CLIの場合:

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

クイックスタート

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

サーバーはデフォルトでhttp://0.0.0.0:3000/mcpでリッスンします。

Docker

docker compose up --build

composeファイルは./docs/pdfsをコンテナに読み取り専用でマウントするため、イメージを再ビルドすることなくローカルでPDFを追加できます。

PDFフォルダー

CODESYSマニュアル、ベンダーPDF、プロジェクトメモ、データシート、またはエクスポートされたドキュメントを以下に配置してください:

docs/pdfs/

MCPサーバーは、そのフォルダー内の.pdfファイルからテキストを抽出し、以下を通じて利用可能にします:

• sourceMode: "pdf" または sourceMode: "all" を指定した search_codesys_docs

• list_codesys_pdfs

• search_codesys_pdfs

• get_codesys_pdf

PDFテキスト抽出は、検索可能なテキストPDFに対して最適です。スキャンされた画像のみのPDFは、OCRが適用されていない限り、コンテンツがほとんどまたは全く返されない可能性があります。抽出されたテキストには、図、スクリーンショット、書式設定、一部の表が含まれない場合があるため、重要なエンジニアリングの詳細は元のPDFと照らし合わせて確認してください。

設定

CLIの使用方法

# 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

受入チェック

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