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秒のタイムアウト設定があり、長時間のハングアップを防止します。

📦 インストール

環境変数

以下の環境変数を設定することで、ツールの動作を調整できます。

プロジェクトのルートディレクトリに.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. 権限エラー（Permission denied）

CLIを実行する際にEACCESエラーが発生した場合は、以下のコマンドを実行してください。

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

2. ポート拒否エラー

ターゲットポートが使用中でないことと、ネットワークが正常であることを確認してください。他のポートを試すこともできます。

3. タイムアウト問題

リクエストが長時間応答しない場合は、タイムアウト設定を増やすか、ネットワーク状態を確認してください。

🔧 技術詳細

このツールは、深度ウィキ（Deepwiki）から知識を取得するためのもので、マルチスレッドクローリング、リトライ機能、タイムアウト制御などの機能を備えています。ユーザーは環境変数を設定することで、ツールの動作を柔軟に調整できます。また、Dockerを使用してデプロイすることも可能です。

📄 ライセンス

本READMEにはライセンス情報が記載されていません。

項目貢献

コミュニティの開発者の皆様からのこのプロジェクトの開発と保守への参加を歓迎します。貢献ガイドを参照して、プロジェクトに貢献する方法を確認してください。

連絡先

何か問題があれば、プロジェクトのメンテナに連絡してください：[連絡先]

⚠️ 重要提示

このプロジェクトはまだ開発中であり、不安定または未完成の機能が存在する可能性があります。使用する前に、ドキュメントをよく読み、テストを十分に行ってください。