CODESYS MCP 服务器

一个用于 CODESYS Development System V3 的模型上下文协议 (MCP) 服务器。它为 MCP 客户端提供精选的 CODESYS 指南、结构化文本编写帮助、可搜索的本地 PDF 文档，以及可选的白名单内 CODESYS 官方页面实时查询功能。

该服务器可以通过 HTTP 在 /mcp 运行，也可以通过 stdio 运行以实现直接的 CLI 和代理集成。官方页面内容会被总结和引用，而不是直接复制到项目中。主要的官方来源包括 CODESYS 在线帮助 和 CODESYS 示例。

工具

• 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 指南以获取概念、语法和工作流帮助。

• 解释常见的 CODESYS 主题，如 POU、功能块、定时器、任务、变量、库、调试和结构化文本。

• 提供实用的结构化文本和项目结构指南。

• 搜索放置在 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 文件提取文本，并通过以下方式使其可用：

• search_codesys_docs (使用 sourceMode: "pdf" 或 sourceMode: "all")

• list_codesys_pdfs

• search_codesys_pdfs

• get_codesys_pdf

PDF 文本提取最适合可搜索的文本型 PDF。除非已应用 OCR，否则仅包含扫描图像的 PDF 可能返回很少或没有内容。提取的文本可能会省略图表、截图、格式和某些表格，因此重要的工程细节应与原始 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