Documentation Manager

🚀 MCP 文檔

MCP 文檔服務提供了便捷的文檔管理功能，支持文檔的讀取、寫入和列出等操作，還能生成文檔索引和統計報告，幫助用戶高效管理文檔。

🚀 快速開始

要開始使用 MCP 文檔，請按照以下步驟操作：

1. 安裝依賴：

   npm install mcp-docs-service
   

2. 運行服務：

   npx mcp-docs-service /path/to/docs
   

✨ 主要特性

• 支持基於文件系統的文檔操作，如讀取、寫入和列出。
• 可指定輸出目錄、日誌級別、輸出格式等。
• 提供文檔掃描和索引生成功能。

📦 安裝指南

安裝依賴

npm install mcp-docs-service

運行服務

npx mcp-docs-service /path/to/docs

💻 使用示例

基礎用法

將所有文檔文件放在 docs 目錄中，然後在終端運行：

npx mcp-docs-service docs

高級用法

指定輸出目錄

npx mcp-docs-service --output-dir output docs

設置日誌級別

npx mcp-docs-service --log-level debug docs

生成文檔索引文件

npx mcp-docs-service --index docs index.html

指定輸出格式為 JSON

npx mcp-docs-service --format json docs output.json

掃描整個文檔目錄並輸出統計信息

npx mcp-docs-service --scan docs stats.json

使用自定義配置文件

npx mcp-docs-service --config config.json docs

📚 詳細文檔

更多關於 MCP 文檔服務的信息，請參考以下鏈接：

• 入門指南
• MCP 集成指南
• MCP 協議使用說明
• 工具參考文檔

🔧 技術細節

MCP 文檔協議

MCP 文檔服務是一個基於文件系統的協議，支持以下操作：

操作類型

1. 讀取文檔內容

   {
     "action": "read",
     "path": "/docs/example.md"
   }
   

2. 寫入文檔內容

   {
     "action": "write",
     "content": "## 新文檔\n這是一個新的 Markdown 文檔。",
     "path": "/docs/new.md"
   }
   

3. 列出所有文檔

   {
     "action": "list",
     "dir": "/docs"
   }
   

回應格式

每個操作的回應都包含一個 status 字段，可能的值為：

• "success"：操作完成。
• "error"：發生錯誤。

配置選項

MCP 文檔服務支持以下配置選項：

基本配置

• --output-dir：指定輸出目錄，默認為當前目錄。
• --log-level：設置日誌級別，可選值有 debug, info, warning, error。

高級配置

• --scan：啟用文檔掃描功能，生成統計報告。
• --index：生成文檔索引文件。
• --format：指定輸出格式，支持 markdown 和 json。

工具參考

MCP 文檔服務提供了以下工具：

文檔掃描器

# 掃描文檔目錄並生成統計報告
npx mcp-docs-service --scan docs report.json

索引生成器

# 生成文檔索引文件
npx mcp-docs-service --index docs index.html

📄 許可證

MCP 文檔服務遵循 MIT 許可證，詳細內容請查看 LICENSE 文件。

⚠️ 重要提示

以上內容為 MCP 文檔服務的簡要說明，更多高級功能和配置選項請參考項目文檔。

💡 使用建議

• 若遇到找不到文檔目錄的問題，可檢查路徑是否正確，或者使用絕對路徑。
• 若掃描功能不工作，確保你安裝了最新版本的 MCP 文檔服務，並重新運行命令。