一个CLI工具,用于生成一个自包含且可运行的MCP(模型上下文协议)服务器,该服务器通过特定工具公开markdown文档。
模型上下文协议(MCP)是一个开放标准,使AI助手能够访问外部工具和数据源。通过将您的文档转换为MCP服务器,您可以让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 <pattern> --packageName <n> [--outDir <dir>] [--toolName <name>]
-d, --docs <pattern>: markdown文件的通配符模式(必需)-p, --packageName <n>: 生成的MCP服务器的名称(必需)-o, --outDir <dir>: 打包服务器的输出目录(默认:"dist")-t, --toolName <name>: 正在记录的工具/包/库的名称(用于工具描述)-v, --version: 输出当前版本# 从docs目录中的所有markdown文件生成服务器
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: 使用模糊匹配搜索所有文档一旦您的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。