RTFM

🚀 MCP-RTFM サーバー

MCP-RTFMは強力なドキュメント管理と分析機能を備えたサーバーです。ドキュメント間のリンク管理、メタデータに基づく組織化、高度な内容分析、強力な検索機能など、様々な機能を提供します。

🚀 クイックスタート

MCP-RTFMサーバーを使い始めるには、まず必要なソフトウェアをインストールし、サーバーを起動する必要があります。以下の手順に従って設定してください。

✨ 主な機能

MCP-RTFM は、以下のような核心機能を提供します。

1. ドキュメント内容リンク：[[document-name]] 形式でドキュメント間にリンクを作成します。サーバーはこれらの関係を自動的に追跡し、関連ドキュメントを検索する際に一緒に返します。
2. メタデータに基づく組織管理：
   • 「アーキテクチャ」、「API」、「ワークフロー」などのカテゴリでドキュメントを分類します。
   • 柔軟なタグを使用してグループ化します。
   • 共有メタデータに基づいてドキュメント間の関係を自動的に検出します。
   • 内容リンク分析に基づいて関連付けを確立します。
3. 強化された内容分析：
   • unified/remark ライブラリを使用してMarkdownを処理します。
     • ASTに基づく内容分析。
     • 正確なタイトル構造の検出。
     • コードブロックとリンクの抽出。
     • 効率的なMarkdown解析と操作の実現。
4. 強力な検索機能：
   • minisearch ライブラリを使用して高速な曖昧検索を実現します。
   • フィールドの重みに基づいて検索します（タイトルを優先）。
   • 全文内容とメタデータを検索します。
   • 効率的なキャッシュとTTL管理をサポートします。
   • リアルタイムの検索インデックス更新を実現します。
5. スマートなメタデータ生成：
   • 内容に基づいて自動的に分類します。
   • 内容パターンに基づいてスマートにタグを生成します。
   • ドキュメント内で構造化されたFront-matterを使用します。
   • ASTに基づいてタイトルと部分を検出します。
   • コードスニペットを識別してマーキングします。
   • コンテキストに基づいて結果を表示します。
6. テンプレートシステム：
   • 一般的なドキュメントタイプのテンプレートを内蔵しています。
   • カスタムテンプレートをサポートし、メタデータのデフォルト値を提供します。
   • テンプレートの継承と上書き機能を実現します。
   • 形式の一貫性を確保するためのプレースホルダーシステムを提供します。

📦 インストール

VSCodeでのインストール（Roo Cline）

以下の内容をグローバル設定ファイルに追加してください。

• Windowsシステム：%APPDATA%\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\cline_mcp_settings.json
• MacOSシステム：~/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
• Linuxシステム：~/.config/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json

追加する設定内容は以下の通りです。

{
    "mcpServers": {
        "mcp-rtfm": {
            "command": "node",
            "args": ["<path-to-mcp-rtfm>/build/index.js"],
            "disabled": false,
            "alwaysAllow": []
        }
    }
}

Claude Desktopでのインストール

以下の内容を設定ファイルに追加してください。

• Windowsシステム：%APPDATA%\Claude\claude_desktop_config.json
• MacOSシステム：~/Library/Application Support/Claude/claude_desktop_config.json
• Linuxシステム：~/.config/Claude/claude_desktop_config.json

追加する設定内容は以下の通りです。

{
    "mcpServers": {
        "mcp-rtfm": {
            "command": "node",
            "args": ["<path-to-mcp-rtfm>/build/index.js"],
            "disabled": false,
            "alwaysAllow": []
        }
    }
}

開発とデプロイ

依存関係のインストール

プロジェクトのルートディレクトリで以下のコマンドを実行して、すべての依存関係をインストールしてください。

npm install

サーバーの起動

以下のコマンドを使用して、MCP-RTFMサーバーを起動します。

node index.js

デバッグツール

デバッグを容易にするために、以下のコマンドを使用してデバッグオプション付きでサーバーを起動できます。

node --inspect index.js

📚 ドキュメント

新しいドキュメントの作成

プロジェクトディレクトリに新しいMarkdownファイルを作成し、以下の形式で内容を記述してください。

# 新しいドキュメントのタイトル

## 概要
ドキュメントの内容や目的を簡単に説明します。

### 使用方法
1. MCP-RTFMサーバーを開きます。
2. ドキュメント管理画面に移動します。
3. 新しいドキュメントをアップロードします。

### サンプルコード
```javascript
// これはサンプルコードの断片です
function greeting(name) {
    return `Hello, ${name}!`;
}

関連リンク

[[関連ドキュメント]] [[別の関連ドキュメント]]

### 検索機能
MCP-RTFMは強力な検索機能を提供し、以下の操作をサポートしています。
1. **全文検索**：キーワードを直接入力して曖昧検索を行います。
2. **カテゴリに基づく検索**：カテゴリでドキュメントを絞り込みます。
3. **タグに基づく検索**：特定のタグを使用して関連する内容を検索します。

#### 使用例
```bash
// 「アーキテクチャ」キーワードを含むすべてのドキュメントを検索する
search --query "アーキテクチャ"

// カテゴリで検索する
search --category "API"

テンプレートシステム

MCP-RTFMは柔軟なテンプレートシステムを提供し、以下の操作をサポートしています。

1. 新しいテンプレートの作成：templates ディレクトリに新しいファイルを作成します。
2. 既存のテンプレートの適用：ドキュメント内で [[template-name]] 形式でテンプレートを参照します。

テンプレートの例

# テンプレートを使用したサンプルドキュメント

## ドキュメントの概要
{{ documentOverview }}

### 具体的な内容
{{ documentContent }}

高度な機能

自動化ワークフロー

MCP-RTFMは自動化ワークフローをサポートし、CI/CDパイプラインに統合できます。

ログ記録と監視

サーバーは詳細なログ記録と監視機能を提供し、システムの実行状態を追跡するのに役立ちます。

セキュリティ

デフォルトで認証と承認メカニズムが有効になっており、ドキュメントの安全なアクセスを確保します。

問題のトラブルシューティング

一般的な問題

1. サーバーが起動しない場合 インストールが正しく行われていることを確認し、すべての依存関係がインストールされていることを確認し、コンソール出力のエラーメッセージを確認してください。
2. 検索結果が不正確な場合 インデックスが正しく生成されていることを確認し、クエリ構文が正しいことを確認してください。

プロジェクトへの貢献

コミュニティからのプロジェクト開発への参加を歓迎します！GitHubリポジトリにアクセスして、問題やプルリクエストを送信してください。

📄 ライセンス

MCP-RTFMはApache 2.0ライセンスの下で提供されています。詳細はLICENSEファイルを参照してください。

MCP-RTFMをご利用いただき、ありがとうございます！さらなる支援が必要な場合は、いつでもドキュメントを参照するか、サポートチームにお問い合わせください。