Open Docs MCP

🚀 open-docs-mcp ドキュメントサーバー

このプロジェクトは、ドキュメント管理機能を提供するオープンソースのMCP実装です。

[日本語ドキュメント][url-doczh]

🚀 クイックスタート

open-docs-mcpサーバーを起動するには、以下のコマンドを使用します。

npm start

✨ 主な機能

ドキュメント管理

• 複数のソースからドキュメントを収集し、インデックスを作成します。
• 複数のドキュメント形式をサポートします。
• 全文検索機能を提供します。

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 - すべての利用可能なドキュメントをリストします。

Cursor @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   │
├───────────────────┼───────────────────┼───────────────┤
│ - 网页抓取         │ - 全文索引       │ - 文档管理    │
│ - 文档存储        │                  │              │
└───────────────────┴───────────────────┴───────────────┘

📦 インストール

インストール手順

1. リポジトリをクローンします：git clone https://github.com/your-repository.git
2. ディレクトリに移動します：cd open-docs-mcp
3. 依存関係をインストールします：npm install

設定ファイル

サーバーを設定するために、config.json ファイルを作成することができます。

{
  "port": 3000,
  "documentRoot": "./documents"
}

💻 使用例

基本的な使用法

open-docs-mcpサーバーを起動するには、以下のコマンドを使用します。

npm start

高度な使用法

開発を開始するには、以下のコマンドを実行します。

• ファイルの変更を監視する：npm run watch
• デバッグモードで起動する：npm run debug

🤝 コントリビューションガイド

コミュニティからの貢献を歓迎します！ 詳細は、プロジェクトリポジトリの CONTRIBUTING.md を参照してください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。