Deepwiki Markdown Converter

🚀 深維基工具

這是一個用於從深度維基（Deepwiki）獲取知識的工具，支持多種運行方式和靈活配置，為用戶提供了便捷的知識獲取途徑。

🚀 快速開始

安裝依賴

npm install

運行開發版本（標準輸入輸出模式）

pnpm run dev-stdio

構建項目

pnpm run build

直接調用API

可以通過以下命令直接調用工具的API：

curl -X POST http://localhost:3000/mcp \
  -H "Content-Type: application/json" \
  -d '{
    "id": "req-1",
    "action": "deepwiki_fetch",
    "params": {
      "url": "https://deepwiki.org/user/repo",
      "mode": "aggregate"
    }
}'

✨ 主要特性

• 多線程爬取：默認情況下，該工具會以5個併發請求運行，但用戶可以根據需要通過環境變量調整。
• 重試機制：在遇到網絡問題時，工具會在250ms後重新嘗試失敗的請求，默認最多重試3次。
• 超時控制：每個請求默認有30秒的超時設置，以防止長時間掛起。

📦 安裝指南

環境變量

通過設置以下環境變量，可以調整工具的行為：

• DEEPWIKI_MAX_CONCURRENCY：最大併發請求數，默認為5。
• DEEPWIKI_REQUEST_TIMEOUT：每個請求的超時時間（單位：毫秒），默認為30000。
• DEEPWIKI_MAX_RETRIES：最大重試次數，默認為3。
• DEEPWIKI_RETRY_DELAY：重試的基礎延遲時間（單位：毫秒），默認為250。

在項目根目錄下創建一個.env文件，內容如下：

DEEPWIKI_MAX_CONCURRENCY=10
DEEPWIKI_REQUEST_TIMEOUT=60000
DEEPWIKI_MAX_RETRIES=5
DEEPWIKI_RETRY_DELAY=500

Docker部署（未經測試）

構建鏡像

docker build -t mcp-deepwiki .

運行容器

• 開發模式：

docker run -it --rm mcp-deepwiki

• 生產模式：

docker run -d -p 3000:3000 mcp-deepwiki --http --port 3000

帶環境變量的運行

docker run -d -p 3000:3000 \
  -e DEEPWIKI_MAX_CONCURRENCY=10 \
  -e DEEPWIKI_REQUEST_TIMEOUT=60000 \
  mcp-deepwiki --http --port 3000

📚 詳細文檔

開發指南

安裝依賴

pnpm install

運行開發模式（標準輸入輸出）

pnpm run dev-stdio

執行測試

pnpm test

運行代碼檢查工具

pnpm run lint

常見問題解決

1. 權限 denied 錯誤

如果運行 CLI 時遇到 EACCES 錯誤，請執行以下命令：

chmod +x ./node_modules/.bin/mcp-deepwiki

2. 端口被拒絕連接

確保目標端口未被佔用且網絡正常。可以嘗試使用其他端口。

3. 超時問題

如果請求長時間無響應，可以考慮增加超時設置或檢查網絡狀態。

🤝 項目貢獻

歡迎社區開發者參與此項目的開發和維護。請參考貢獻指南瞭解如何為項目貢獻力量。

📞 聯繫方式

如有任何問題，請聯繫項目維護者：[聯繫方式]

⚠️ 重要提示

本項目仍在開發中，可能存在不穩定或未完善的功能。使用前請仔細閱讀文檔並做好測試工作。