CODESYS MCP Server

Сервер протокола Model Context Protocol (MCP) для системы разработки CODESYS V3. Он предоставляет клиентам MCP курируемые руководства по CODESYS, помощь в написании Structured Text, возможность поиска по локальной PDF-документации и опциональный просмотр разрешенных официальных страниц CODESYS.

Сервер может работать по HTTP через /mcp или через stdio для прямой интеграции с CLI и агентами. Официальные страницы суммируются и цитируются, а не копируются в проект. Основные официальные источники включают CODESYS Online Help и CODESYS Examples.

Инструменты

• search_codesys_docs: поиск по курируемым и/или официальным руководствам CODESYS.

• get_codesys_topic: объяснение известной темы, такой как POU, функциональные блоки, таймеры, задачи, переменные, библиотеки, отладка или Structured Text.

• codesys_writing_guidance: предоставление практических рекомендаций по проектированию на CODESYS и Structured Text для запрошенной задачи.

• list_codesys_pdfs: список PDF-документов, доступных в настроенной папке PDF.

• search_codesys_pdfs: поиск по тексту, извлеченному из локальных PDF-документов.

• get_codesys_pdf: получение извлеченного текста из конкретного локального PDF-документа.

• get_codesys_page: получение полного текстового содержимого любого разрешенного URL-адреса документации CODESYS.

• crawl_codesys_help: сканирование и индексация сайта справки CODESYS для поиска по документации.

Related MCP server: mql5-help-mcp

Что он делает

• Ищет курируемые руководства CODESYS по концепциям, синтаксису и помощи в рабочих процессах.

• Объясняет общие темы CODESYS, такие как POU, функциональные блоки, таймеры, задачи, переменные, библиотеки, отладка и Structured Text.

• Предоставляет практические рекомендации по Structured Text и структуре проекта.

• Ищет по локальным PDF-руководствам и заметкам, размещенным в docs/pdfs/.

• Получает и суммирует разрешенные официальные страницы документации 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.

Установка для ИИ или агента

ИИ-агент? Прочитайте agent.md — там содержится полное пошаговое руководство по самостоятельной установке, написанное специально для вас. Начните с него.

Используйте этот раздел, когда ИИ дается инструкция подключиться к серверу в качестве клиента MCP.

Предлагаемая инструкция для ИИ:

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 в этой папке и делает их доступными через:

• search_codesys_docs с sourceMode: "pdf" или sourceMode: "all"

• 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