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！如需更多帮助，请随时查阅文档或联系支持团队。