MCP 文档

安装与启动

要开始使用 MCP 文档，请按照以下步骤操作：

1. 安装依赖：

   npm install mcp-docs-service
   

2. 运行服务：

   npx mcp-docs-service /path/to/docs
   

快速入门

基本用法

将所有文档文件放在 docs 目录中，然后在终端运行：

npx mcp-docs-service docs

高级选项

• 指定输出目录：

  npx mcp-docs-service --output-dir output docs
  

• 设置日志级别：

  npx mcp-docs-service --log-level debug docs
  

MCP 文档协议

MCP 文档服务是一个基于文件系统的协议，支持以下操作：

操作类型

1. 读取文档内容

   {
     "action": "read",
     "path": "/docs/example.md"
   }
   

2. 写入文档内容

   {
     "action": "write",
     "content": "## 新文档\n这是一个新的 Markdown 文档。",
     "path": "/docs/new.md"
   }
   

3. 列出所有文档

   {
     "action": "list",
     "dir": "/docs"
   }
   

回应格式

每个操作的回应都包含一个 status 字段，可能的值为：

• "success"：操作完成。
• "error"：发生错误。

示例用法

基本示例

# 生成文档索引文件
npx mcp-docs-service --index docs index.html

# 指定输出格式为 JSON
npx mcp-docs-service --format json docs output.json

高级示例

# 扫描整个文档目录并输出统计信息
npx mcp-docs-service --scan docs stats.json

# 使用自定义配置文件
npx mcp-docs-service --config config.json docs

配置选项

MCP 文档服务支持以下配置选项：

基本配置

• --output-dir：指定输出目录，默认为当前目录。
• --log-level：设置日志级别，可选值有 debug, info, warning, error。

高级配置

• --scan：启用文档扫描功能，生成统计报告。
• --index：生成文档索引文件。
• --format：指定输出格式，支持 markdown 和 json。

工具参考

MCP 文档服务提供了以下工具：

1. 文档扫描器

# 扫描文档目录并生成统计报告
npx mcp-docs-service --scan docs report.json

2. 索引生成器

# 生成文档索引文件
npx mcp-docs-service --index docs index.html

故障排除

常见问题

• 问题：找不到文档目录。

• 解决方法：检查路径是否正确，或者使用绝对路径。

• 问题：扫描功能不工作。

• 解决方法：确保你安装了最新版本的 MCP 文档服务，并重新运行命令。

详细文档

更多关于 MCP 文档服务的信息，请参考以下链接：

• 入门指南
• MCP 集成指南
• MCP 协议使用说明
• 工具参考文档

许可证

MCP 文档服务遵循 MIT 许可证，详细内容请查看 LICENSE 文件。

注意：以上内容为 MCP 文档服务的简要说明，更多高级功能和配置选项请参考项目文档。