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. クロールが有効になっているドキュメントのクロールを開始する
  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ツールで強制的に再クロールする

建築

┌───────────────────────────────────────────────────────┐ │ open-docs-mcp Server │ ├───────────────────┬───────────────────┬───────────────┤ │ Crawler Module │ Search Engine │ MCP Server │ ├───────────────────┼───────────────────┼───────────────┤ │ - Web crawling │ - Full-text index │ - Resources │ │ - Doc conversion │ - Relevance score │ - Tools │ │ - Storage │ - Query parsing │ - Prompts │ └───────────────────┴───────────────────┴───────────────┘

使用法

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

Smithery経由でインストール

Smithery経由で Claude Desktop 用の Document Management Server を自動的にインストールするには:

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 : 必須。ドキュメントディレクトリのパスを指定します。
  • disabled : サーバーを一時的に無効にするには true に設定します
  • alwaysAllow : 確認なしで使用できるツール名の配列

発達

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

貢献

プルリクエストは歓迎します。大きな変更については、まずイシューを開いて、変更したい点についてご相談ください。

ライセンス

マサチューセッツ工科大学

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