Deepwiki Markdown Converter

🚀 DeepWiki Tool

A tool for retrieving knowledge from Deepwiki, supporting multiple running modes and flexible configuration.

🚀 Quick Start

Install Dependencies

npm install

Run the Development Version (Standard Input/Output Mode)

pnpm run dev-stdio

Build the Project

pnpm run build

Call the API Directly

You can directly call the tool's API using the following command:

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"
    }
}'

✨ Features

• Multi-threaded Crawling: By default, the tool runs with 5 concurrent requests, but users can adjust this via environment variables as needed.
• Retry Mechanism: In case of network issues, the tool will retry failed requests after 250ms, with a maximum of 3 retries by default.
• Timeout Control: Each request has a default timeout of 30 seconds to prevent long hangs.

📦 Installation

Environment Variables

You can adjust the tool's behavior by setting the following environment variables:

• DEEPWIKI_MAX_CONCURRENCY: The maximum number of concurrent requests, default is 5.
• DEEPWIKI_REQUEST_TIMEOUT: The timeout for each request (in milliseconds), default is 30000.
• DEEPWIKI_MAX_RETRIES: The maximum number of retries, default is 3.
• DEEPWIKI_RETRY_DELAY: The base delay for retries (in milliseconds), default is 250.

Create a .env file in the project root directory with the following content:

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

Docker Deployment (Untested)

Build the Image

docker build -t mcp-deepwiki .

Run the Container

• Development Mode:

docker run -it --rm mcp-deepwiki

• Production Mode:

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

Run with Environment Variables

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

📚 Documentation

Development Guide

Install Dependencies

pnpm install

Run in Development Mode (Standard Input/Output)

pnpm run dev-stdio

Execute Tests

pnpm test

Run the Code Checker

pnpm run lint

Common Problem Solutions

1. Permission Denied Error

If you encounter an EACCES error when running the CLI, execute the following command:

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

2. Port Connection Refused

Ensure that the target port is not occupied and the network is functioning properly. You can try using a different port.

3. Timeout Issue

If a request doesn't respond for a long time, consider increasing the timeout setting or checking the network status.

🤝 Project Contribution

Community developers are welcome to participate in the development and maintenance of this project. Please refer to the Contribution Guide to learn how to contribute to the project.

📞 Contact Information

If you have any questions, please contact the project maintainer: [Contact Information]

⚠️ Important Note

This project is still under development, and there may be unstable or incomplete features. Please read the documentation carefully and conduct thorough testing before use.