AI导哈

文档转MCP服务器工具

一个CLI工具，用于生成自包含、可运行的MCP服务器，通过特定工具暴露Markdown文档内容。

  • by Tiberriver256
  • TypeScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 tiberriver256/docs-to-mcp-cli

使用说明

@tiberriver256/docs到mcp-cli

一个CLI工具，生成一个自包含、可运行的MCP（模型上下文协议）服务器，该服务器通过特定工具公开markdown文档。

什么是MCP？

这 模型上下文协议（MCP） 是一个开放标准，使人工智能助手能够访问外部工具和数据源。通过将文档转换为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>：标记文件的球形图案（必填）
  • -p, --packageName <n>：生成的MCP服务器的名称（必需）
  • -o, --outDir <dir>：捆绑服务器的输出目录（默认：“dist”）
  • -t, --toolName <name>：记录的工具/包/库的名称（用于工具描述）
  • -v, --version：输出当前版本

例子

# Generate a server from all markdown files in the docs directory
docs-to-mcp-cli --docs "docs/**/*.md" --packageName ProjectDocs

# Specify a custom tool name and output directory
docs-to-mcp-cli --docs "documentation/**/*.md" --packageName APIDocsServer --toolName "My API" --outDir build

# Run the generated server
node dist/index.js

生成的服务器工具

生成的MCP服务器为AI助手提供以下工具：

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

与AI助手集成

一旦您的MCP服务器运行，支持模型上下文协议的AI助手就可以连接到它并访问您的文档。这使得人工智能能够根据您的特定文档提供更准确和上下文相关的响应。

发展

要在本地构建CLI工具，请执行以下操作：

# Clone the repository
git clone https://github.com/Tiberriver256/docs-to-mcp-cli.git
cd docs-to-mcp-cli

# Install dependencies
npm install

# Build the project
npm run build

# Link for local development
npm link

当前版本

当前版本为1.1.2。请参阅 更改日志.md 有关最近更新的详细信息。

相关 MCP