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

💻 使用示例

基礎用法

創建新文檔

在項目目錄中創建一個新的 Markdown 文件，並按照以下格式編寫內容：

# 新文檔標題

## 概述

簡要描述文檔的內容或目的。

### 使用方法

1. 打開 MCP - RTFM 服務器。
2. 導航到文檔管理界面。
3. 上傳您的新文檔。

### 示例代碼

```javascript
// 這是一個示例代碼片段
function greeting(name) {
    return `Hello, ${name}!`;
}

相關鏈接

[[相關文檔]] [[另一個相關文檔]]

#### 搜索功能使用示例
```bash
// 搜索所有包含 "架構" 關鍵詞的文檔
search --query "架構"

// 根據類別搜索
search --category "API"

模板系統模板示例

# 使用模板的示例文檔

## 文檔概述

{{ documentOverview }}

### 具體內容

{{ documentContent }}

高級用法

啟動服務器

使用以下命令啟動 MCP - RTFM 服務器：

node index.js

調試工具

為了方便調試，您可以使用以下命令啟動帶有調試選項的服務器：

node --inspect index.js

📚 詳細文檔

文檔管理

創建新文檔

在項目目錄中創建一個新的 Markdown 文件，並按照特定格式編寫內容，包含概述、使用方法、示例代碼和相關鏈接等部分。

搜索功能

MCP - RTFM 提供強大的搜索功能，支持全文搜索、基於類別的搜索和基於標籤的搜索。

模板系統

MCP - RTFM 提供靈活的模板系統，支持創建新模板和應用現有模板。

高級功能

自動化工作流

MCP - RTFM 支持自動化的工作流，可以集成到 CI/CD 管道中。

日誌記錄與監控

服務器提供詳細的日誌記錄和監控功能，幫助您跟蹤系統運行狀態。

安全性

默認啟用身份驗證和授權機制，確保文檔的安全訪問。

🔧 技術細節

安裝依賴項

在項目根目錄下運行 npm install 命令以安裝所有依賴項。

啟動服務器

使用 node index.js 命令啟動 MCP - RTFM 服務器。

調試工具

使用 node --inspect index.js 命令啟動帶有調試選項的服務器，方便進行調試工作。

📄 許可證

MCP - RTFM 由 Apache 2.0 許可證授權，詳情請查看 LICENSE 文件。

感謝您使用 MCP - RTFM！如需更多幫助，請隨時查閱文檔或聯繫支持團隊。