mcpField
@
@tiberriver256/docs-to-mcp-cli

@tiberriver256/docs-to-mcp-cli

本地服务
github.com/Tiberriver256记忆与知识280 周前更新

关于 @tiberriver256/docs-to-mcp-cli

@tiberriver256/docs-to-mcp-cli 是一款命令行工具,可将 Markdown 文档打包为可运行的独立 MCP 服务,让 AI 助手能够列出、搜索和读取文档。

主要功能

  1. 01生成打包后的 MCP 服务
  2. 02用 glob 模式选择 Markdown 文件
  3. 03列出文档并显示预览
  4. 04读取完整文档内容
  5. 05模糊搜索文档

适用场景

  1. 01向 AI 助手开放项目文档
  2. 02从 Markdown 文件创建可搜索的 MCP 接口

MCP 相关

该命令行工具生成 stdio MCP 服务,向连接的 MCP 客户端提供 `list_docs`、`get_doc` 和 `search_docs` 工具。

配置

本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
"mcpServers": {
"docs-to-mcp-cli": {
"command": "npx",
"args": [
"-y",
"@tiberriver256/docs-to-mcp-cli"
]
}
}
}
启动命令npx -y @tiberriver256/docs-to-mcp-cli

本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。

安装包
npm@tiberriver256/docs-to-mcp-cli

工具

还没有获取到工具列表

本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。

详细介绍

@tiberriver256/docs-to-mcp-cli

一个 CLI 工具,可生成自包含且可运行的 MCP(Model Context Protocol)服务,通过特定工具提供 Markdown 文档。

什么是 MCP?

Model Context Protocol(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:输出当前版本
示例
# 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 服务运行后,支持 Model Context Protocol 的 AI 助手即可连接并访问文档。这样,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。有关近期更新的详情,请参阅 CHANGELOG.md。

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。