githubViewRepoStructure
Analyze and explore GitHub repository structures to identify key directories, validate paths, and fetch essential files for project understanding. Supports adjustable depth levels for efficient navigation and insight.
Instructions
Explore GitHub repository structure and validate repository access.
PROJECT UNDERSTANDING:
- Try to understand more by the structure of the project and the files in the project
- Identify key directories and file patterns
- fetch important files for better understanding
DEPTH CONTROL:
- Default depth is 2 levels for balanced performance and insight
- Maximum depth is 4 levels to prevent excessive API calls
- Depth 1: Shows only immediate files/folders in the specified path
- Depth 2+: Recursively explores subdirectories up to the specified depth
- Higher depths provide more comprehensive project understanding but use more API calls
IMPORTANT:
- verify default branch (use main or master if can't find default branch)
- verify path before calling the tool to avoid errors
- Start with root path to understand actual repository structure and then navigate to specific directories based on research needs
- Check repository's default branch as it varies between repositories
- Verify path exists - don't assume repository structure
- Verify repository existence and accessibility
- Validate paths before accessing specific files. Use github search code to find correct paths if unsure
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| branch | Yes | Branch name. Default branch varies between repositories. Tool will automatically try default branch if specified branch is not found, but it is more efficient to verify the correct branch first. | |
| depth | No | Depth of directory structure to explore. Default is 2. Maximum is 4 to prevent excessive API calls and maintain performance. | |
| includeIgnored | No | If true, shows all files and folders including configuration files, lock files, hidden directories, etc. Default is false to show only relevant code files and directories. for optimization | |
| owner | Yes | Repository owner/organization name (e.g., "facebook", "microsoft"). Do NOT include repository name. | |
| path | No | Directory path within repository. Start with empty path to see actual repository structure first. Do not assume repository structure or nested paths exist. Do not start with slash. Verify path exists before using specific directories. | |
| repo | Yes | Repository name under a organization. | |
| showMedia | No | If true, shows media files (images, videos, audio, documents). Default is false to hide media files and focus on code structure. |