MCP 서버 문서화 프로젝트

이 프로젝트는 Model Context Protocol(MCP) 서버의 구성 요소를 문서화하는 작업입니다.

설치 및 실행

필요한 도구

• Node.js (v14 이상)
• npm 또는 yarn
• Playwright

설치 방법

1. 필요한 패키지 설치:

   npm install playwright
   # 또는
   yarn add playwright

2. Playwright 브라우저 설치:

   npx playwright install chromium

문서화 스크립트 실행

다음 명령어로 문서화 스크립트를 실행할 수 있습니다:

node documentComponent.js

프로젝트 구조

MyMCP/
├── MCP_문서/
│   ├── MCP 서버 목록/
│   │   ├── 레퍼런스 서버/
│   │   │   ├── 서버 상세/
│   │   │   │   ├── [각 서버 구성 요소].md
│   │   │   ├── 레퍼런스 서버 개요.md
├── documentComponent.js  # 문서화 자동화 스크립트
├── project_plan.md       # 프로젝트 계획 문서
└── README.md             # 프로젝트 설명 문서

사용법

1. documentComponent.js 파일 내의 componentsToDocument 배열에 문서화할 구성 요소 이름을 추가합니다.
2. 스크립트를 실행하면 각 구성 요소에 대한 문서가 자동으로 생성됩니다.
3. 생성된 문서는 Obsidian 볼트의 MCP_문서/MCP 서버 목록/레퍼런스 서버/서버 상세/ 디렉토리에 저장됩니다.
4. 레퍼런스 서버 개요 문서에 각 구성 요소에 대한 링크가 자동으로 추가됩니다.

개별 구성 요소 문서화

특정 구성 요소만 문서화하려면 documentComponent.js 파일을 수정하여 원하는 구성 요소만 포함시키거나, 다음과 같이 Node.js REPL에서 직접 함수를 호출할 수 있습니다:

const { documentComponent } = require('./documentComponent');
documentComponent('filesystem', '/Users/jjw/Library/Mobile Documents/iCloud~md~obsidian/Documents/MyMCP');

문서 구조

각 구성 요소 문서는 다음 구조를 따릅니다:

1. 개요: 구성 요소에 대한 일반적인 설명
2. 파일 구조: 구성 요소의 파일 및 디렉토리 목록
3. 주요 기능: 구성 요소가 제공하는 주요 기능
4. 코드 예시: 핵심 파일의 코드 샘플
5. 연결된 구성 요소: 다른 구성 요소와의 관계

추가 작업 및 개선 사항

• 코드 분석 기능 개선: 더 정확한 기능 추출
• 다이어그램 생성: 구성 요소 간 관계 시각화
• 검색 기능 추가: 문서 내용 검색 기능