@tiberriver256/docs-to-mcp-cli

一个 CLI 工具，用于生成一个独立的、可运行的 MCP (模型上下文协议) 服务器，该服务器通过特定工具公开 markdown 文档。

什么是 MCP？

模型上下文协议 (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 文件的 Glob 模式 (必需)
• -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: 使用模糊匹配搜索所有文档

与 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。