CODESYS MCP 서버

CODESYS Development System V3를 위한 모델 컨텍스트 프로토콜(MCP) 서버입니다. MCP 클라이언트에게 엄선된 CODESYS 가이드, 구조화된 텍스트(Structured Text) 작성 도움말, 검색 가능한 로컬 PDF 문서, 그리고 허용된 공식 CODESYS 페이지에 대한 선택적 실시간 조회 기능을 제공합니다.

이 서버는 /mcp 경로의 HTTP를 통해 실행하거나, 직접적인 CLI 및 에이전트 통합을 위해 stdio를 통해 실행할 수 있습니다. 공식 페이지는 프로젝트에 복사되는 대신 요약 및 인용됩니다. 주요 공식 소스로는 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 가이드를 검색합니다.

• 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