Docs To MCP Cli

🚀 將文檔轉換為 MCP CLI 工具

這是一個命令行工具，可生成自包含且可運行的 MCP（模型上下文協議）服務器，該服務器能通過特定工具公開標記語言文檔，讓 AI 助手更好地訪問和利用這些文檔。

🚀 快速開始

本工具可幫助您將文檔轉換為 MCP 服務器，使 AI 助手能瀏覽、搜索和訪問文檔內容，從而提供更準確和基於上下文的響應。

✨ 主要特性

• 支持全局安裝或使用 npx 直接運行。
• 可根據標記語言文件生成 MCP 服務器。
• 生成的服務器為 AI 助手提供 list_docs、get_doc 和 search_docs 等工具。
• 支持與支持模型上下文協議的 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>]

選項說明

高級用法

# 從文檔目錄中的所有標記語言文件生成服務器
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 以獲取最近更新的詳細信息。