Documentation Manager

🚀 MCP ドキュメント

MCP ドキュメントは、ドキュメントの管理や操作を容易にするサービスです。このサービスを使用することで、ドキュメントの読み取り、書き込み、一覧表示などの操作が簡単に行えます。

🚀 クイックスタート

📦 インストール

MCP ドキュメントを使用するには、まず依存関係をインストールし、サービスを起動する必要があります。以下の手順に従って操作してください。

1. 依存関係のインストール

npm install mcp-docs-service

2. サービスの起動

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

✨ 主な機能

💻 使用例

基本的な使用法

すべてのドキュメントファイルを docs ディレクトリに配置し、以下のコマンドをターミナルで実行します。

npx mcp-docs-service docs

高度な使用法

• 出力ディレクトリの指定

npx mcp-docs-service --output-dir output docs

• ログレベルの設定

npx mcp-docs-service --log-level debug docs

MCP ドキュメントプロトコル

MCP ドキュメントサービスは、ファイルシステムに基づくプロトコルをサポートしており、以下の操作が可能です。

操作タイプ

1. ドキュメント内容の読み取り

{
  "action": "read",
  "path": "/docs/example.md"
}

2. ドキュメント内容の書き込み

{
  "action": "write",
  "content": "## 新しいドキュメント\nこれは新しい Markdown ドキュメントです。",
  "path": "/docs/new.md"
}

3. すべてのドキュメントの一覧表示

{
  "action": "list",
  "dir": "/docs"
}

応答形式

各操作の応答には status フィールドが含まれ、以下の値が可能です。

• "success"：操作が完了しました。
• "error"：エラーが発生しました。

具体的な使用例

基本的な使用例

# ドキュメントインデックスファイルの生成
npx mcp-docs-service --index docs index.html

# 出力形式を JSON に指定
npx mcp-docs-service --format json docs output.json

高度な使用例

# ドキュメントディレクトリ全体をスキャンし、統計情報を出力
npx mcp-docs-service --scan docs stats.json

# カスタム設定ファイルの使用
npx mcp-docs-service --config config.json docs

設定オプション

MCP ドキュメントサービスは、以下の設定オプションをサポートしています。

基本設定

• --output-dir：出力ディレクトリを指定します。デフォルトは現在のディレクトリです。
• --log-level：ログレベルを設定します。選択可能な値は debug, info, warning, error です。

高度な設定

• --scan：ドキュメントスキャン機能を有効にし、統計レポートを生成します。
• --index：ドキュメントインデックスファイルを生成します。
• --format：出力形式を指定します。サポートされている形式は markdown と json です。

ツールリファレンス

MCP ドキュメントサービスは、以下のツールを提供しています。

1. ドキュメントスキャナー

# ドキュメントディレクトリをスキャンし、統計レポートを生成
npx mcp-docs-service --scan docs report.json

2. インデックス生成器

# ドキュメントインデックスファイルを生成
npx mcp-docs-service --index docs index.html

トラブルシューティング

一般的な問題と解決策

• 問題：ドキュメントディレクトリが見つからない。

• 解決策：パスが正しいことを確認するか、絶対パスを使用してください。

• 問題：スキャン機能が機能しない。

• 解決策：最新バージョンの MCP ドキュメントサービスをインストールし、コマンドを再実行してください。

📚 ドキュメント

MCP ドキュメントサービスに関する詳細情報は、以下のリンクを参照してください。

• 入門ガイド
• MCP 統合ガイド
• MCP プロトコル使用説明
• ツールリファレンスドキュメント

📄 ライセンス

MCP ドキュメントサービスは MIT ライセンスに従っています。詳細は LICENSE ファイルを参照してください。

⚠️ 重要提示

上記の内容は MCP ドキュメントサービスの概要説明です。より高度な機能や設定オプションについては、プロジェクトのドキュメントを参照してください。