open-docs-mcp

by askme765cs
Verified

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Supports indexing and searching of Markdown-formatted documentation, enabling access to content in this format through the document management system.

  • Runs as a Node.js application, with specific version requirements (>=16.0.0) to enable the document management functionality.

  • Built with TypeScript 4.9.5, providing type safety and modern language features for the document management implementation.

open-docs-mcp MCP 서버

문서 관리 기능을 제공하는 오픈 소스 MCP 구현입니다.

특징

문서 관리

  • 다양한 소스에서 크롤링 및 인덱싱 문서
  • 다양한 문서 형식 지원
  • 전체 텍스트 검색 기능

MCP 서버 API

  • 문서에 대한 리소스 기반 액세스
  • 도구 기반 문서 관리

사용 가능한 도구

  1. enable_doc - 특정 문서에 대한 크롤링을 활성화합니다.
  2. disable_doc - 특정 문서에 대한 크롤링을 비활성화합니다.
  3. crawl_docs - 활성화된 문서 크롤링 시작
  4. build_index - 문서 검색 인덱스 빌드
  5. search_docs - 문서 검색
  6. list_enabled_docs - 활성화된 문서 목록
  7. list_all_docs - 사용 가능한 모든 문서 나열

커서 @Docs 호환성

이 프로젝트는 다음을 제공하여 Cursor의 @Docs 기능을 복제하는 것을 목표로 합니다.

  1. 문서 인덱싱 :
    • 다양한 소스에서 크롤링 및 인덱싱 문서
    • 다양한 문서 형식 지원(HTML, Markdown 등)
    • 문서를 최신 상태로 유지하기 위한 자동 재색인화
  2. 문서 접근 :
    • 색인된 모든 문서 검색
    • AI 컨텍스트를 위한 MCP 프로토콜과의 통합
  3. 사용자 정의 문서 관리 :
    • enable_doc 도구를 통해 새로운 문서 소스를 추가합니다.
    • list_enabled_docs 도구를 통해 활성화된 문서 관리
    • crawl_docs 도구를 사용하여 강제로 다시 크롤링

건축학

지엑스피1

용법

npx -y open-docs-mcp --docsDir ./docs

Smithery를 통해 설치

Smithery를 통해 Claude Desktop용 문서 관리 서버를 자동으로 설치하려면:

npx -y @smithery/cli install @askme765cs/open-docs-mcp --client claude

구성

Claude Desktop과 함께 사용하려면 서버 구성을 추가하세요.

MacOS의 경우: ~/Library/Application Support/Claude/claude_desktop_config.json Windows의 경우: %APPDATA%/Claude/claude_desktop_config.json

{ "mcpServers": { "open-docs-mcp": { "command": "npx", "args": [ "-y", "open-docs-mcp", "--docsDir", "/path/to/docs" ] } } }

구성 옵션:

  • command : Node.js 실행 파일
  • args : 스크립트에 전달할 인수 배열
    • --docsDir : 필수, docs 디렉토리 경로를 지정합니다.
  • disabled : 서버를 일시적으로 비활성화하려면 true로 설정합니다.
  • alwaysAllow : 확인 없이 사용할 수 있는 도구 이름 배열

개발

npm run watch # Auto-rebuild on changes npm run inspector # Debug with MCP Inspector

기여하다

풀 리퀘스트는 환영합니다. 중요한 변경 사항이 있는 경우, 먼저 이슈를 열어 변경 사항을 논의해 주세요.

특허

MIT

You must be authenticated.

A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

문서 관리 기능을 제공하는 오픈소스 MCP 구현입니다. 이 프로젝트의 목표는 Cursor의 @Docs 기능을 복제하는 것입니다.

  1. Features
    1. Document Management
    2. MCP Server API
    3. Available Tools
    4. Cursor @Docs Compatibility
    5. Architecture
  2. Usage
    1. Installing via Smithery
    2. Configuration
  3. Development
    1. Contributing
      1. License
        ID: rphxhyntan