Servidor MCP de CODESYS

Un servidor del Protocolo de Contexto de Modelo (MCP) para el Sistema de Desarrollo CODESYS V3. Proporciona a los clientes MCP orientación seleccionada sobre CODESYS, ayuda para escribir Texto Estructurado, documentación PDF local con capacidad de búsqueda y consulta opcional en vivo de páginas oficiales de CODESYS permitidas.

El servidor puede ejecutarse a través de HTTP en /mcp o mediante stdio para una integración directa con CLI y agentes. Las páginas oficiales se resumen y citan en lugar de copiarse en el proyecto. Las fuentes oficiales principales incluyen Ayuda en línea de CODESYS y Ejemplos de CODESYS.

Herramientas

• search_codesys_docs: busca orientación seleccionada y/o oficial de CODESYS.

• get_codesys_topic: explica un tema conocido como POU, bloques de funciones, temporizadores, tareas, variables, bibliotecas, depuración o Texto Estructurado.

• codesys_writing_guidance: proporciona orientación práctica sobre el diseño en CODESYS y Texto Estructurado para una tarea solicitada.

• list_codesys_pdfs: enumera los documentos PDF disponibles en la carpeta de PDF configurada.

• search_codesys_pdfs: busca texto extraído de documentos PDF locales.

• get_codesys_pdf: devuelve el texto extraído de un documento PDF local específico.

• get_codesys_page: obtiene el contenido de texto completo de cualquier URL de documentación de CODESYS permitida.

• crawl_codesys_help: rastrea e indexa el sitio de ayuda de CODESYS para obtener documentación con capacidad de búsqueda.

Related MCP server: mql5-help-mcp

Qué hace

• Busca orientación seleccionada de CODESYS para conceptos, sintaxis y ayuda con el flujo de trabajo.

• Explica temas comunes de CODESYS como POU, bloques de funciones, temporizadores, tareas, variables, bibliotecas, depuración y Texto Estructurado.

• Proporciona orientación práctica sobre Texto Estructurado y estructura de proyectos.

• Busca en manuales PDF locales y notas colocadas en docs/pdfs/.

• Obtiene y resume páginas de documentación oficial de CODESYS permitidas.

• Rastrea el sitio de ayuda oficial para crear un índice con capacidad de búsqueda.

Instalación para humanos

Utilice esto cuando desee ejecutar el servidor usted mismo en su máquina.

Requisitos previos:

• Node.js 20 o superior

• npm

Desde un clon nuevo:

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

Inicie el servidor HTTP:

npm start

O inicie el servidor stdio:

npm run start:stdio

De forma predeterminada, el servidor HTTP escucha en http://0.0.0.0:3000/mcp.

Instalación para una IA o agente

¿Agente de IA? Lea agent.md: contiene la guía de autoinstalación completa, paso a paso, escrita específicamente para usted. Empiece por ahí.

Utilice esta sección cuando se le indique a una IA que se conecte al servidor como cliente MCP.

Instrucción sugerida para darle a la IA:

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

1. Primero, compile el proyecto:

npm install
npm run build

2. Prefiera el transporte stdio para la integración con agentes locales.

3. Agregue el servidor al cliente utilizando la salida de compilación local:

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

4. Si el cliente necesita HTTP en su lugar, inicie el servidor y registre el punto final:

npm start

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

5. Si el agente solo puede trabajar desde un paquete publicado, utilice:

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

Para Codex CLI:

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

Inicio rápido

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

El servidor escucha en http://0.0.0.0:3000/mcp de forma predeterminada.

Docker

docker compose up --build

El archivo compose monta ./docs/pdfs en el contenedor como de solo lectura, por lo que puede agregar archivos PDF localmente sin reconstruir la imagen.

Carpeta PDF

Coloque manuales de CODESYS, archivos PDF de proveedores, notas de proyectos, hojas de datos o documentación exportada en:

docs/pdfs/

El servidor MCP extrae texto de archivos .pdf en esa carpeta y los pone a disposición a través de:

• search_codesys_docs con sourceMode: "pdf" o sourceMode: "all"

• list_codesys_pdfs

• search_codesys_pdfs

• get_codesys_pdf

La extracción de texto de PDF es mejor para archivos PDF con texto buscable. Los PDF escaneados que solo contienen imágenes pueden devolver poco o ningún contenido a menos que ya se haya aplicado OCR. El texto extraído puede omitir diagramas, capturas de pantalla, formato y algunas tablas, por lo que los detalles de ingeniería importantes deben verificarse con el PDF original.

Configuración

Uso de 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

Comprobaciones de aceptación

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