基本能力
产品定位
MCP Documentation Service 是一个专为 Markdown 文档管理设计的服务，支持与 AI 助手集成，提供高效的文档读写、编辑和管理功能。
核心功能
- 读写文档：支持 Markdown 文档及其前端元数据的读写
- 编辑文档：提供基于行的精确编辑功能，支持差异预览
- 列表与搜索：根据内容或元数据查找文档
- 导航生成：从文档中生成导航结构
- 健康检查：分析文档质量，识别如缺失元数据或损坏链接等问题
- LLM 优化文档：生成适合大型语言模型的单文档输出
- MCP 集成：与 Model Context Protocol 无缝集成
- 前端元数据支持：全面支持 Markdown 文档中的 YAML 前端元数据
- Markdown 兼容性：与标准 Markdown 文件兼容
适用场景
- 项目管理中的文档维护
- AI 辅助的文档编辑和管理
- 文档质量检查和优化
- 大型语言模型上下文文档生成
工具列表
- mcp_docs_manager_read_document：读取指定路径的文档
- mcp_docs_manager_write_document：写入内容到指定文档
- mcp_docs_manager_edit_document：编辑文档内容
- mcp_docs_manager_search_documents：搜索文档内容
- mcp_docs_manager_generate_navigation：生成文档导航
- mcp_docs_manager_check_documentation_health：检查文档健康状况
常见问题解答
- 服务未出现：检查日志文件，确保 Node.js 已安装，路径正确
- 文档健康检查：使用
--health-check参数运行服务 - 集成问题：确保配置文件路径正确，重启 Claude Desktop
使用教程
使用依赖
- 需要安装 Node.js
安装教程
bash
npm install -g mcp-docs-service
或直接使用 npx：
bash
npx mcp-docs-service /path/to/docs
Cursor 集成
在项目根目录创建 .cursor/mcp.json 文件：
json
{
"mcpServers": {
"docs-manager": {
"command": "npx",
"args": ["-y", "mcp-docs-service", "/path/to/your/docs"]
}
}
}
Claude Desktop 集成
- 下载并安装 Claude Desktop
- 配置
claude_desktop_config.json文件添加 MCP Docs Service - 重启 Claude Desktop
调试方式
- 检查日志文件：
- macOS:
~/Library/Logs/Claude/mcp*.log - Windows:
%APPDATA%\Claude\logs\mcp*.log - 确保 Node.js 已安装
- 验证路径是否正确
示例命令
@docs-manager mcp_docs_manager_read_document path=docs/getting-started.md
@docs-manager mcp_docs_manager_search_documents query="getting started"
@docs-manager mcp_docs_manager_check_documentation_health
