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. 超时问题

如果请求长时间无响应，可以考虑增加超时设置或检查网络状态。

🤝 项目贡献

欢迎社区开发者参与此项目的开发和维护。请参考贡献指南了解如何为项目贡献力量。

📞 联系方式

如有任何问题，请联系项目维护者：[联系方式]

⚠️ 重要提示

本项目仍在开发中，可能存在不稳定或未完善的功能。使用前请仔细阅读文档并做好测试工作。