mcp-docs-toolkit은(는) 무엇을 하나요?
문서 워크플로우 검증, 패키징 및 유지보수를 위한 MCP 툴킷으로, Codex 친화적 검사를 포함합니다.
개요
이 MCP 툴킷은 문서 중심 개발 워크플로우에서 발생하는 일반적인 문제를 해결합니다. 문서를 작성, 검증, 패키징하고 최종 배포 전에 일관성을 유지하도록 돕습니다. Codex와 같은 AI 코딩 에이전트와 함께 사용하도록 설계되어, 사람과 기계 모두가 읽을 수 있는 문서를 생성합니다.
주요 기능
- 문서 검증: 잘못된 링크, 누락된 섹션, 일관성 없는 스타일 등을 검사합니다.
- 패키징: 문서를 다양한 포맷(HTML, PDF 등)으로 변환합니다.
- 워크플로우 유지보수: 문서 업데이트 시 기존 검증 규칙과 구조를 유지합니다.
- Codex 친화적: AI 에이전트가 문서를 쉽게 분석하고 이해할 수 있도록 구조화합니다.
설치
npm install -g @andrea201709/mcp-docs-toolkit
# 또는
npx @andrea201709/mcp-docs-toolkit
사용법
기본 검증 실행:
mcp-docs-toolkit validate --path ./docs
패키징 실행:
mcp-docs-toolkit package --input ./docs --output ./dist
도움말 보기:
mcp-docs-toolkit --help
설정
프로젝트 루트에 mcp-docs-toolkit.config.json 파일을 생성하여 규칙을 사용자 정의할 수 있습니다:
{
"validate": {
"links": true,
"headings": true,
"tables": true
},
"package": {
"format": "html",
"outputDir": "./dist"
}
}
환경 변수
MCP_DOCS_TOOLKIT_DIR: 설정 파일과 출력물의 기본 디렉토리 (~/.mcp-docs-toolkit)를 재정의합니다.
지원되는 플랫폼
- Node.js 18 이상
- macOS, Linux, Windows (WSL)
- CI/CD 파이프라인 (GitHub Actions, GitLab CI 등)
라이선스
MIT
}