Use this skill when the user asks to explore a repository, get familiar with a project, "repo explorer", "tell me about this repo", "repo-explorer", "what do...
Note: If you have
mcporterinstalled locally, you should usemcporterto invoke the MCP tool instead of directly calling the MCP tool. ThemcporterCLI provides a more convenient interface and better error handling.
Quickly explore the structure and core content of a Gitee repository and generate an overview report to help get up to speed on an unfamiliar project.
get_file_content, search_files_by_content, list_user_repos)Start by reading these files using get_file_content:
README.md or README_CN.md: project introductionCONTRIBUTING.md: contribution guide (development conventions)CHANGELOG.md: change history (evolution of the project)package.json / go.mod / pom.xml / requirements.txt: tech stack and dependenciesFirst, use get_file_content with path="/" to get the root directory tree:
get_file_content(owner="[owner]", repo="[repo]", path="/")
This returns the top-level directory structure in a single call, providing a quick overview of the project's layout.
Then, browse key subdirectories to identify:
Common project structure patterns
src/ or lib/: core source codecmd/ or bin/: CLI entry points (Go / C++ projects)api/ or routes/: API definitionstests/ or test/: test codedocs/: detailed documentationscripts/ or .gitee/ or .github/: build / CI scriptsconfig/ or configs/: configuration filesBased on the project type, read key files in depth:
Web application
Library / SDK
CLI tool
Use search_files_by_content to locate core logic:
main, init, Router, etc.# 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]
If the user has a specific area of interest, use search_files_by_content for targeted searches:
auth, token, permissionSELECT, INSERT, Modelconfig, env, ENVZIP package — ready to use