使用说明

项目简介

'docs-to-mcp-cli' 是一个命令行工具，用于将 Markdown 文档转换为一个可以直接运行的 MCP (Model Context Protocol) 服务器。通过这个工具，您可以轻松地将您的文档内容以 MCP 协议的方式暴露给支持 MCP 的 AI 助手，使得 AI 助手能够浏览、搜索和利用您的文档信息，从而提供更准确、更具上下文的回复。

主要功能点

Markdown 文档转换: 将指定目录下的 Markdown 文档转换为 MCP 服务器可用的数据格式。
自包含服务器: 生成的服务器包含所有必要的代码和依赖，可以独立运行。
文档浏览与检索: 提供 'list_docs' 工具列出文档，'get_doc' 工具获取文档内容，'search_docs' 工具搜索文档内容。
工具集成: 内置 'list_docs', 'get_doc', 'search_docs' 三个工具，方便 AI 助手访问文档。
灵活配置: 支持自定义服务器名称、工具名称和输出目录。

安装步骤

安装 Node.js 和 npm: 确保您的系统已安装 Node.js 和 npm (Node Package Manager)。

全局安装 CLI 工具: 打开终端，运行以下命令全局安装 'docs-to-mcp-cli':

npm install -g @tiberriver256/docs-to-mcp-cli

服务器配置

生成的 MCP 服务器需要通过 MCP 客户端连接才能使用。MCP 客户端需要配置服务器的启动命令和参数。'docs-to-mcp-cli' 工具会生成一个 'dist/index.js' 文件，您需要配置客户端连接到这个服务。以下是一个 MCP 客户端配置示例 (JSON 格式):

{
  "serverName": "YourPackageName",  // 请替换为生成服务器时指定的 packageName
  "command": "node",
  "args": ["dist/index.js"]
}

配置参数说明:

'serverName': 服务器名称，需要与您在运行 'docs-to-mcp-cli' 命令时通过 '--packageName' 参数指定的名称一致。
'command': 运行服务器的命令，通常为 'node'。
'args': 命令参数，指向生成的服务器入口文件 'dist/index.js'。

基本使用方法

生成 MCP 服务器: 在终端中使用 'docs-to-mcp-cli' 命令，指定 Markdown 文档路径和服务器名称：
```
docs-to-mcp-cli --docs "path/to/your/markdown/docs/**/*.md" --packageName YourDocsServer
```
- '--docs "path/to/your/markdown/docs//*.md"': 指定 Markdown 文档的路径，可以使用 glob 模式匹配多个文件。请替换 '"path/to/your/markdown/docs//*.md"' 为您实际的文档路径。
- '--packageName YourDocsServer': 指定生成的 MCP 服务器的名称，例如 'YourDocsServer'。这个名称将用于 MCP 客户端的配置。
运行 MCP 服务器: 生成成功后，进入输出目录 (默认为 'dist')，运行以下命令启动服务器：
```
node dist/index.js
```
服务器成功启动后，会显示 '[YourDocsServer] MCP Server connected via stdio.' (其中 'YourDocsServer' 为您指定的服务器名称)。
配置 MCP 客户端: 根据上述 "服务器配置" 部分的说明，配置您的 MCP 客户端连接到刚刚启动的服务器。
AI 助手使用: 配置完成后，您的 AI 助手即可通过 MCP 协议访问您文档服务器提供的工具，例如 'list_docs', 'get_doc', 'search_docs'，从而利用您的文档内容。

关键词