repo-explorer

注記：ローカルに mcporter がインストールされている場合は、MCP ツールを直接呼び出すのではなく、mcporter を使って MCP ツールを呼び出してください。mcporter CLI を使うと、より便利に操作でき、エラー処理も向上します。

Gitee MCP によるリポジトリの探索

Gitee リポジトリの構造と主要な内容をすばやく調べ、概要レポートを生成して、初めて触れるプロジェクトの理解を助けます。

前提条件

• Gitee MCP サーバーが設定済みであること（ツール：get_file_content、search_files_by_content、list_user_repos）
• ユーザーがリポジトリのオーナーとリポジトリ名を指定すること
• 任意：関心のある分野（例：「認証の仕組みを理解したい」）

手順

手順 1：主要なドキュメントを取得する

まず、get_file_content を使って次のファイルを読みます。

1. README.md または README_CN.md：プロジェクトの紹介
2. CONTRIBUTING.md：コントリビューションガイド（開発規約）
3. CHANGELOG.md：変更履歴（プロジェクトの変遷）
4. package.json / go.mod / pom.xml / requirements.txt：技術スタックと依存関係

手順 2：プロジェクトの構造を調べる

まず、path="/" を指定して get_file_content を使い、ルートディレクトリのツリーを取得します。

get_file_content(owner="[owner]", repo="[repo]", path="/")

これにより、1 回の呼び出しで最上位のディレクトリ構造が返され、プロジェクトの構成をすばやく把握できます。

次に、主要なサブディレクトリを調べ、以下を確認します。

一般的なプロジェクト構造のパターン

• src/ または lib/：コアのソースコード
• cmd/ または bin/：CLI のエントリーポイント（Go / C++ プロジェクト）
• api/ または routes/：API 定義
• tests/ または test/：テストコード
• docs/：詳細なドキュメント
• scripts/ または .gitee/ または .github/：ビルド / CI スクリプト
• config/ または configs/：設定ファイル

手順 3：コアコードを分析する

プロジェクトの種類に応じて、主要なファイルを詳しく読みます。

Web アプリケーション

• エントリーファイル（main.go / index.js / app.py）
• ルート定義ファイル
• データベースのスキーマまたはモデル定義

ライブラリ / SDK

• メインのエントリーファイル（パブリック API のエントリーポイント）
• コアアルゴリズムのファイル

CLI ツール

• コマンド定義ファイル
• 設定処理のロジック

search_files_by_content を使ってコアロジックを探します。

• main、init、Router などを検索します。
• ユーザーの関心分野に合ったキーワードを検索します。

手順 4：リポジトリの概要レポートを生成する

# Repository Overview: [owner/repo]

## About
[One-paragraph description summarizing the project based on the README]

## Tech Stack
- **Language**: [primary language]
- **Framework**: [main framework]
- **Storage**: [database / cache]
- **Deployment**: [Docker / K8s / other]

## Directory Structure
[Key directory annotations]
├── src/          # Core source code
├── api/          # API definitions
├── tests/        # Tests
└── docs/         # Documentation

## Core Modules
| Module | Path | Responsibility |
|--------|------|---------------|
| [name] | [path] | [one-sentence description] |

## Data Models (if applicable)
[Main entities and their relationships]

## Getting Started
[Setup steps extracted from README / CONTRIBUTING]

\`\`\`bash
# Install dependencies
[command]

# Start the project
[command]
\`\`\`

## Contribution Highlights
[Key conventions from CONTRIBUTING.md]

## Recent Activity
[Latest version highlights from CHANGELOG or README]

手順 5：詳しく調べる（任意）

ユーザーが特定の分野に関心がある場合は、search_files_by_content を使って対象を絞り込んで検索します。

• 認証：auth、token、permission を検索します。
• データベース操作：SELECT、INSERT、Model を検索します。
• 設定：config、env、ENV を検索します。

注意事項

• ファイルを読むときは、サイズの小さいファイルを優先し、非常に大きなファイルを一度に読み込まないようにします。
• レポートの内容を絞り込み、簡潔にまとめます。すべてを網羅しようとしないでください。
• プロジェクトに README がない場合は、コードの構造やコメントから目的を推測します。