基本能力
产品定位
MCP-RTFM 是一个专注于文档创建和管理的工具,旨在通过自动化内容分析和元数据生成,提升项目文档的质量和可读性。
核心功能
- 文档管理工具:
analyze_existing_docs
:分析和增强现有文档。analyze_project_with_metadata
:初始化文档结构并生成元数据。search_docs
:智能搜索文档内容。update_metadata
:更新文档元数据。get_related_docs
:查找相关文档。-
customize_template
:创建或更新文档模板。 -
默认文档文件:
-
自动生成和管理核心文档文件,如
techStack.md
、codebaseDetails.md
等。 -
文档模板:
- 提供内置模板,支持自定义模板创建。
适用场景
- 项目文档初始化和管理。
- 现有文档的增强和优化。
- 团队协作中的文档共享和搜索。
- 开发流程中的文档自动生成和更新。
使用教程
使用依赖
```bash
安装依赖
npm install
```
安装教程
```bash
构建服务器
npm run build
添加到 MCP 设置并开始使用
await use_mcp_tool({
server: "mcp-rtfm",
tool: "analyze_project_with_metadata",
args: { projectPath: "/path/to/project" }
});
```
调试方式
```bash
使用 MCP Inspector 进行调试
npm run inspector
```
常见问题解答
- 如何更新文档?
-
使用
update_doc
工具进行文档更新。 -
如何搜索文档?
-
使用
search_docs
工具进行智能搜索。 -
如何创建自定义模板?
- 使用
customize_template
工具创建自定义模板。