@tiberriver256/docs-to-mcp-cli

@tiberriver256/docs-to-mcp-cli

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

Overview

基本能力

产品定位

docs-to-mcp-cli 是一个用于将 Markdown 文档转换为 MCP 服务器的工具,旨在帮助 AI 助手更好地访问和利用文档内容。

核心功能

  • 将 Markdown 文档转换为自包含的 MCP 服务器。
  • 提供工具列表,包括 list_docsget_docsearch_docs,用于浏览、获取和搜索文档内容。
  • 支持 AI 助手通过 MCP 协议访问文档内容。

适用场景

  • 为 AI 助手提供文档访问能力。
  • 在开发过程中快速生成文档服务器。
  • 需要将文档内容集成到 AI 助手中的场景。

工具列表

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

常见问题解答

使用教程

使用依赖

  • 需要安装 Node.js 和 npm。

安装教程

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

或使用 npx:

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

调试方式

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

许可证

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