docs-to-mcp-cli

docs-to-mcp-cli

site icon
2025.04.28 0
TypeScript文档转换MCP 服务器生成开发效率
docs-to-mcp-cli 是一个命令行工具,用于生成一个自包含、可运行的 MCP(Model Context Protocol)服务器,该服务器通过特定工具暴露 Markdown 文档。MCP 是一个开放标准,允许 AI 助手访问外部工具和数据源。通过将文档转换为 MCP 服务器,AI 助手可以浏览、搜索文档内容,并提供更准确和上下文的响应。
View on GitHub

Overview

基本能力

产品定位

docs-to-mcp-cli 是一个用于将 Markdown 文档转换为 MCP 服务器的工具,旨在通过 MCP 协议使 AI 助手能够访问和利用文档内容。

核心功能

  • 将 Markdown 文档转换为 MCP 服务器
  • 提供文档浏览、搜索和访问功能
  • 支持自定义工具名称和输出目录
  • 生成自包含、可运行的服务器

适用场景

  • 为 AI 助手提供文档访问能力
  • 在开发过程中快速生成文档服务器
  • 集成到现有文档系统中,增强 AI 助手的响应能力

工具列表

  • list_docs: 列出所有可用文档及其内容预览
  • get_doc: 获取特定文档的完整内容
  • search_docs: 使用模糊匹配搜索所有文档

常见问题解答

  • 如何安装?使用 npm 全局安装或通过 npx 直接运行。
  • 如何运行生成的服务器?使用 node dist/index.js 命令。

使用教程

使用依赖

  • 需要安装 Node.js 和 npm

安装教程

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

npx @tiberriver256/docs-to-mcp-cli --docs "path/to/docs/**/*.md" --packageName MyDocsServer

调试方式

# 运行生成的服务器
node dist/index.js

开发

# 克隆仓库
git clone https://github.com/Tiberriver256/docs-to-mcp-cli.git
cd docs-to-mcp-cli

# 安装依赖
npm install

# 构建项目
npm run build

# 本地开发链接
npm link

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。