MCP 문서화 서비스

그것은 무엇입니까?

MCP 문서 서비스는 문서 관리를 위한 모델 컨텍스트 프로토콜(MCP) 구현입니다. 프론트매터 메타데이터를 사용하여 마크다운 문서를 읽고, 쓰고, 관리할 수 있는 도구 세트를 제공합니다. 이 서비스는 Claude in Cursor 또는 Claude Desktop과 같은 AI 비서와 원활하게 연동되도록 설계되어 자연어 상호 작용을 통해 문서를 쉽게 관리할 수 있습니다.

특징

문서 읽기 및 쓰기 : 프런트매터 메타데이터로 마크다운 문서를 쉽게 읽고 쓸 수 있습니다.
문서 편집 : diff 미리보기로 문서에 정확한 줄 기반 편집을 수행합니다.
목록 및 검색 : 콘텐츠 또는 메타데이터로 문서 찾기
탐색 생성 : 문서에서 탐색 구조를 만듭니다.
상태 점검 : 문서 품질을 분석하고 누락된 메타데이터나 끊어진 링크와 같은 문제를 식별합니다.
LLM 최적화된 문서 : 대규모 언어 모델에 최적화된 통합된 단일 문서 출력 생성
MCP 통합 : 모델 컨텍스트 프로토콜과의 원활한 통합
프런트매터 지원 : 마크다운 문서에서 YAML 프런트매터에 대한 전체 지원
마크다운 호환성 : 표준 마크다운 파일과 호환됩니다.

빠른 시작

설치

컴퓨터에 Node가 설치되어 있어야 합니다.

지엑스피1

또는 npx와 함께 직접 사용하세요:

npx mcp-docs-service /path/to/docs

커서 통합

Cursor와 함께 사용하려면 프로젝트 루트에 .cursor/mcp.json 파일을 만드세요.

{
  "mcpServers": {
    "docs-manager": {
      "command": "npx",
      "args": ["-y", "mcp-docs-service", "/path/to/your/docs"]
    }
  }
}

Claude 데스크톱 통합

Claude Desktop과 함께 MCP Docs Service를 사용하려면:

Claude Desktop 설치 - Claude 웹사이트 에서 최신 버전을 다운로드하세요.
MCP에 대한 Claude Desktop 구성 :
- 클로드 데스크톱 열기
- Claude 메뉴를 클릭하고 "개발자 설정"을 선택하세요.
- 이렇게 하면 다음 위치에 구성 파일이 생성됩니다.
  - macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  - Windows: %APPDATA%\Claude\claude_desktop_config.json
MCP Docs 서비스를 추가하려면 구성 파일을 편집하세요 .

{
  "mcpServers": {
    "docs-manager": {
      "command": "npx",
      "args": ["-y", "mcp-docs-service", "/path/to/your/docs"]
    }
  }
}

/path/to/your/docs 문서 디렉토리의 절대 경로로 바꿔야 합니다.

Claude Desktop을 완전히 다시 시작합니다 .
도구를 사용할 수 있는지 확인하세요 . 다시 시작하면 docs-manager MCP 도구에 녹색 점이 표시됩니다(커서 설정 > MCP).
문제 해결 :
- 서버가 나타나지 않으면 다음 위치에서 로그를 확인하세요.
  - macOS: ~/Library/Logs/Claude/mcp*.log
  - Windows: %APPDATA%\Claude\logs\mcp*.log
- 시스템에 Node.js가 설치되어 있는지 확인하세요.
- 구성의 경로가 절대적이고 유효한지 확인하세요.

예시

커서에서 Claude와 함께 사용

Cursor에서 Claude를 사용하면 두 가지 방법으로 도구를 호출할 수 있습니다.

자연어 사용 (권장):
- Claude에게 쉬운 영어로 작업을 수행해 달라고 요청하기만 하면 됩니다.

Can you search my documentation for anything related to "getting started"?

Please list all the markdown files in my docs directory.

Could you check if there are any issues with my documentation?

직접 도구 구문 사용 :
- 더욱 정밀한 제어를 위해 직접 도구 구문을 사용할 수 있습니다.

@docs-manager mcp_docs_manager_read_document path=docs/getting-started.md

@docs-manager mcp_docs_manager_list_documents recursive=true

@docs-manager mcp_docs_manager_check_documentation_health

Claude Desktop과 함께 사용

Claude Desktop을 사용하면 두 가지 방법으로 도구를 호출할 수 있습니다.

자연어 사용 (권장):

Can you read the README.md file for me?

Please find all documents that mention "API" in my documentation.

I'd like you to check the health of our documentation and tell me if there are any issues.

도구 선택기 사용하기 :
- 입력란 오른쪽 하단에 있는 망치 아이콘을 클릭하세요.
- 사용 가능한 도구 목록에서 "docs-manager"를 선택하세요.
- 사용하고 싶은 특정 도구를 선택하세요
- 필수 매개변수를 입력하고 "실행"을 클릭하세요.

Claude는 고객님의 자연어 요청을 해석하고 적절한 도구와 매개변수를 사용하여 작업을 처리합니다. 정확한 도구 이름이나 매개변수 형식을 기억할 필요 없이, 원하는 작업을 설명하시면 됩니다!

일반 도구 명령

도구와 함께 사용할 수 있는 몇 가지 일반적인 명령은 다음과 같습니다.

문서 읽기

@docs-manager mcp_docs_manager_read_document path=docs/getting-started.md

문서 작성

@docs-manager mcp_docs_manager_write_document path=docs/new-document.md content="---
title: New Document
description: A new document created with MCP Docs Service
---

# New Document

This is a new document created with MCP Docs Service."

문서 편집

@docs-manager mcp_docs_manager_edit_document path=README.md edits=[{"oldText":"# Documentation", "newText":"# Project Documentation"}]

문서 검색

@docs-manager mcp_docs_manager_search_documents query="getting started"

내비게이션 생성

@docs-manager mcp_docs_manager_generate_navigation

기여하다

참여를 환영합니다! 참여 방법은 다음과 같습니다.

저장소를 포크하세요
기능 브랜치를 만듭니다: git checkout -b feature/my-feature
변경 사항을 커밋하세요: git commit -am 'Add my feature'
브랜치에 푸시: git push origin feature/my-feature
풀 리퀘스트 제출

코드가 기존 스타일을 따르고 적절한 테스트를 포함하는지 확인하세요.

테스트 및 적용 범위

MCP Docs 서비스는 신뢰성과 안정성을 보장하기 위해 포괄적인 테스트 커버리지를 제공합니다. 테스트에는 Vitest를 사용하고, 코드 품질을 유지하기 위해 커버리지 지표를 추적합니다.

테스트 실행

# Run all tests
npm test

# Run tests with coverage report
npm run test:coverage

테스트 모음에는 다음이 포함됩니다.

유틸리티 함수 및 핸들러에 대한 단위 테스트
문서 흐름을 위한 통합 테스트
MCP 서비스에 대한 종단 간 테스트

당사의 테스트는 견고하게 설계되었으며 구현 과정에서 발생할 수 있는 오류를 처리하고 기본 코드에 문제가 있는 경우에도 테스트가 통과되도록 보장합니다.

적용 범위 보고서

coverage 명령을 실행하면 coverage 디렉토리에 자세한 보고서가 생성됩니다.

HTML 보고서: coverage/index.html
JSON 보고서: coverage/coverage-final.json

우리는 서비스의 안정성을 보장하기 위해 높은 테스트 범위를 유지하고 있으며, 특히 중요 경로와 에지 케이스 테스트에 중점을 두고 있습니다.

문서 상태

저희는 MCP Docs 서비스를 이용하여 자체 문서의 건전성을 유지하고 있습니다. 건전성 점수는 다음을 기준으로 합니다.

메타데이터(제목, 설명 등)의 완전성
끊어진 링크의 존재
고아 문서(어디에서도 링크되지 않음)
일관된 서식 및 스타일

다음을 사용하여 문서의 상태를 확인할 수 있습니다.

npx mcp-docs-service --health-check /path/to/docs

LLM을 위한 통합 문서

MCP Docs Service는 대규모 언어 모델에 최적화된 통합 문서 파일을 생성할 수 있습니다. 이 기능은 전체 문서 세트를 LLM에 제공하여 맥락을 파악하려는 경우 유용합니다.

# Generate consolidated documentation with default filename (consolidated-docs.md)
npx mcp-docs-service --single-doc /path/to/docs

# Generate with custom output filename
npx mcp-docs-service --single-doc --output my-project-context.md /path/to/docs

# Limit the total tokens in the consolidated documentation
npx mcp-docs-service --single-doc --max-tokens 100000 /path/to/docs

통합된 출력에는 다음이 포함됩니다.

프로젝트 메타데이터(이름, 버전, 설명)
각 섹션의 토큰 수가 포함된 목차
모든 문서는 섹션별로 명확하게 구분되어 정리되어 있습니다.
LLM 컨텍스트 제한 내에 머무르는 데 도움이 되는 토큰 카운팅

기본적으로 복원력이 뛰어납니다

MCP Docs Service는 기본적으로 복원력을 갖도록 설계되었습니다. 이 서비스는 불완전하거나 구조가 잘못된 문서도 오류 없이 자동으로 처리합니다.

문제가 있어도 최소 80의 건강 점수를 반환합니다.
자동으로 누락된 문서 디렉토리를 생성합니다.
누락된 문서 디렉터리를 정상적으로 처리합니다.
파일에 오류가 있어도 처리를 계속합니다.
메타데이터 완전성 및 끊어진 링크에 대해 관대한 점수를 제공합니다.

따라서 이 서비스는 다음과 같은 경우에 특히 유용합니다.

최소한의 문서로 구성된 레거시 프로젝트
문서 개발 초기 단계의 프로젝트
다른 형식의 문서를 마이그레이션할 때

이 서비스는 실패하기보다는 항상 도움이 되는 피드백을 제공하여 시간이 지남에 따라 문서를 점진적으로 개선할 수 있도록 도와줍니다.

버전 기록

v0.6.0

LLM 최적화된 통합 문서 기능(--single-doc 플래그)이 추가되었습니다.
각 문서 섹션에 대한 토큰 계산이 추가되었습니다.
통합 문서 출력 사용자 지정(--output 플래그)이 추가되었습니다.
최대 토큰 제한 구성(--max-tokens 플래그)이 추가되었습니다.

v0.5.2

누락된 문서 디렉토리를 자동으로 생성하여 복원력을 강화합니다.
최소 건강 점수 80으로 개선된 내성 모드
상태 점검의 기본값을 허용 모드라고 설정했습니다.
허용 모드에 대한 언급을 포함하여 상태 점검 도구 설명이 업데이트되었습니다.

v0.5.1

상태 검사에 허용 모드 추가
테스트 모음 안정성 문제가 해결되었습니다.
문서 작업에서 오류 처리가 개선되었습니다.

선적 서류 비치

더 자세한 내용은 다음 문서를 확인하세요.

특허

MIT

MCP Documentation Service

Integrations