🚀 将文档转换为 MCP CLI 工具
这是一个命令行工具，可生成自包含且可运行的 MCP（模型上下文协议）服务器，该服务器能通过特定工具公开标记语言文档，让 AI 助手更好地访问和利用这些文档。
🚀 快速开始
本工具可帮助您将文档转换为 MCP 服务器，使 AI 助手能浏览、搜索和访问文档内容，从而提供更准确和基于上下文的响应。
✨ 主要特性
- 支持全局安装或使用
npx直接运行。 - 可根据标记语言文件生成 MCP 服务器。
- 生成的服务器为 AI 助手提供
list_docs、get_doc和search_docs等工具。 - 支持与支持模型上下文协议的 AI 助手集成。
📦 安装指南
您可以选择以下两种方式安装该工具：
全局安装
npm install -g @tiberriver256/docs-to-mcp-cli
使用 npx 直接运行
npx @tiberriver256/docs-to-mcp-cli --docs "path/to/docs/**/*.md" --packageName MyDocsServer
💻 使用示例
基础用法
docs-to-mcp-cli --docs --packageName [--outDir <dir>] [--toolName ]
选项说明
| 属性 | 详情 |
|---|---|
-d, --docs
|
标记语言文件的通配符模式（必填） |
-p, --packageName |
生成的 MCP 服务器名称（必填） |
-o, --outDir |
输出目录，用于打包服务器（默认： "dist"） |
-t, --toolName |
文档中记录的工具、包或库的名称（用于工具描述） |
-v, --version |
显示当前版本 |
高级用法
# 从文档目录中的所有标记语言文件生成服务器
docs-to-mcp-cli --docs "docs/**/*.md" --packageName ProjectDocs
# 指定自定义工具名称和输出目录
docs-to-mcp-cli --docs "documentation/**/*.md" --packageName APIDocsServer --toolName "My API" --outDir build
# 运行生成的服务器
node dist/index.js
📚 详细文档
生成服务器工具
生成的 MCP 服务器为 AI 助手提供以下工具：
list_docs：列出所有可用文档并显示其内容预览。get_doc：根据路径获取特定文档的全文内容。search_docs：使用模糊匹配搜索所有文档。
与 AI 助手集成
一旦您的 MCP 服务器开始运行，支持模型上下文协议的 AI 助手可以连接到它并访问您的文档。这使 AI 能够根据您特定的文档提供更准确和基于上下文的响应。
🔧 技术细节
开发
要本地构建 CLI 工具，可按以下步骤操作：
# 克隆仓库
git clone https://github.com/Tiberriver256/docs-to-mcp-cli.git
cd docs-to-mcp-cli
# 安装依赖项
npm install
# 构建项目
npm run build
# 链接进行本地开发
npm link
📄 许可证
文档中未提及许可证相关信息。
🔖 当前版本
当前版本是 1.1.2。查看 CHANGELOG.md 以获取最近更新的详细信息。