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. 基于标签的搜索：使用特定标签查找相关内容。

使用示例

// 搜索所有包含 "架构" 关键词的文档
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！如需更多帮助，请随时查阅文档或联系支持团队。