mcpField
R
repo-explorer

repo-explorer

github.com/oschina开发5168 次安装28 周前更新
代码仓库

关于 repo-explorer

repo-explorer 是用于检查 Gitee 仓库并生成精简概览报告的技能。它引导用户从关键文档和目录结构逐步查看核心代码，也支持围绕指定主题进行搜索。

主要功能

  1. 01读取关键项目文档
  2. 02检查仓库目录结构
  3. 03通过内容搜索定位核心逻辑
  4. 04生成仓库概览报告
  5. 05按主题进行定向探索

适用场景

  1. 01快速了解陌生的 Gitee 项目
  2. 02梳理项目技术栈与目录布局
  3. 03追踪身份验证等特定机制

MCP 相关

使用 Gitee MCP 服务的工具读取文件、搜索仓库内容和列出用户仓库；若已安装 mcporter，建议通过它调用这些工具。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/oschina/gitee-agent-skills --skill repo-explorer

安装后在 Claude Code 中输入/repo-explorer确认已加载。

详细介绍

注意：如果你在本地安装了 mcporter，应使用 mcporter 调用 MCP 工具，而不是直接调用 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：探索项目结构

首先，使用 get_file_content 并将 path="/" 设为参数，以获取根目录树：

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

这会在一次调用中返回顶层目录结构，让你快速了解项目布局。

然后，浏览关键子目录以识别：

常见项目结构模式

  • 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，请根据代码结构和注释推断其用途

评论

支持 Markdown