- Notifications
You must be signed in to change notification settings - Fork2.7k
Add Repository Tree Navigation Tool#1164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
natagdunbar wants to merge3 commits intomainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+381 −0
Open
Changes fromall commits
Commits
Show all changes
3 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| { | ||
| "annotations": { | ||
| "title": "Get repository tree", | ||
| "readOnlyHint": true | ||
| }, | ||
| "description": "Get the tree structure (files and directories) of a GitHub repository at a specific ref or SHA", | ||
| "inputSchema": { | ||
| "properties": { | ||
| "owner": { | ||
| "description": "Repository owner (username or organization)", | ||
| "type": "string" | ||
| }, | ||
| "path_filter": { | ||
| "description": "Optional path prefix to filter the tree results (e.g., 'src/' to only show files in the src directory)", | ||
| "type": "string" | ||
| }, | ||
| "recursive": { | ||
| "default": false, | ||
| "description": "Setting this parameter to true returns the objects or subtrees referenced by the tree. Default is false", | ||
| "type": "boolean" | ||
| }, | ||
| "repo": { | ||
| "description": "Repository name", | ||
| "type": "string" | ||
| }, | ||
| "tree_sha": { | ||
| "description": "The SHA1 value or ref (branch or tag) name of the tree. Defaults to the repository's default branch", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "owner", | ||
| "repo" | ||
| ], | ||
| "type": "object" | ||
| }, | ||
| "name": "get_repository_tree" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| package github | ||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
| ghErrors "github.com/github/github-mcp-server/pkg/errors" | ||
| "github.com/github/github-mcp-server/pkg/translations" | ||
| "github.com/google/go-github/v74/github" | ||
| "github.com/mark3labs/mcp-go/mcp" | ||
| "github.com/mark3labs/mcp-go/server" | ||
| ) | ||
| // TreeEntryResponse represents a single entry in a Git tree. | ||
| type TreeEntryResponse struct { | ||
| Path string `json:"path"` | ||
| Type string `json:"type"` | ||
| Size *int `json:"size,omitempty"` | ||
| Mode string `json:"mode"` | ||
| SHA string `json:"sha"` | ||
| URL string `json:"url"` | ||
| } | ||
| // TreeResponse represents the response structure for a Git tree. | ||
| type TreeResponse struct { | ||
| SHA string `json:"sha"` | ||
| Truncated bool `json:"truncated"` | ||
| Tree []TreeEntryResponse `json:"tree"` | ||
| TreeSHA string `json:"tree_sha"` | ||
| Owner string `json:"owner"` | ||
| Repo string `json:"repo"` | ||
| Recursive bool `json:"recursive"` | ||
| Count int `json:"count"` | ||
| } | ||
| // GetRepositoryTree creates a tool to get the tree structure of a GitHub repository. | ||
| func GetRepositoryTree(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) { | ||
| return mcp.NewTool("get_repository_tree", | ||
| mcp.WithDescription(t("TOOL_GET_REPOSITORY_TREE_DESCRIPTION", "Get the tree structure (files and directories) of a GitHub repository at a specific ref or SHA")), | ||
| mcp.WithToolAnnotation(mcp.ToolAnnotation{ | ||
| Title: t("TOOL_GET_REPOSITORY_TREE_USER_TITLE", "Get repository tree"), | ||
| ReadOnlyHint: ToBoolPtr(true), | ||
| }), | ||
| mcp.WithString("owner", | ||
| mcp.Required(), | ||
| mcp.Description("Repository owner (username or organization)"), | ||
| ), | ||
| mcp.WithString("repo", | ||
| mcp.Required(), | ||
| mcp.Description("Repository name"), | ||
| ), | ||
| mcp.WithString("tree_sha", | ||
| mcp.Description("The SHA1 value or ref (branch or tag) name of the tree. Defaults to the repository's default branch"), | ||
| ), | ||
| mcp.WithBoolean("recursive", | ||
| mcp.Description("Setting this parameter to true returns the objects or subtrees referenced by the tree. Default is false"), | ||
| mcp.DefaultBool(false), | ||
| ), | ||
| mcp.WithString("path_filter", | ||
| mcp.Description("Optional path prefix to filter the tree results (e.g., 'src/' to only show files in the src directory)"), | ||
| ), | ||
| ), | ||
| func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) { | ||
| owner, err := RequiredParam[string](request, "owner") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| repo, err := RequiredParam[string](request, "repo") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| treeSHA, err := OptionalParam[string](request, "tree_sha") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| recursive, err := OptionalBoolParamWithDefault(request, "recursive", false) | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| pathFilter, err := OptionalParam[string](request, "path_filter") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| client, err := getClient(ctx) | ||
| if err != nil { | ||
| return mcp.NewToolResultError("failed to get GitHub client"), nil | ||
| } | ||
| // If no tree_sha is provided, use the repository's default branch | ||
| if treeSHA == "" { | ||
| repoInfo, _, err := client.Repositories.Get(ctx, owner, repo) | ||
| if err != nil { | ||
| return mcp.NewToolResultError(fmt.Sprintf("failed to get repository info: %s", err)), nil | ||
| } | ||
| treeSHA = *repoInfo.DefaultBranch | ||
| } | ||
| // Get the tree using the GitHub Git Tree API | ||
| tree, resp, err := client.Git.GetTree(ctx, owner, repo, treeSHA, recursive) | ||
| if err != nil { | ||
| return ghErrors.NewGitHubAPIErrorResponse(ctx, | ||
| "failed to get repository tree", | ||
| resp, | ||
| err, | ||
| ), nil | ||
| } | ||
| defer func() { _ = resp.Body.Close() }() | ||
| // Filter tree entries if path_filter is provided | ||
| var filteredEntries []*github.TreeEntry | ||
| if pathFilter != "" { | ||
| for _, entry := range tree.Entries { | ||
| if strings.HasPrefix(entry.GetPath(), pathFilter) { | ||
| filteredEntries = append(filteredEntries, entry) | ||
| } | ||
| } | ||
| } else { | ||
| filteredEntries = tree.Entries | ||
| } | ||
| treeEntries := make([]TreeEntryResponse, len(filteredEntries)) | ||
| for i, entry := range filteredEntries { | ||
| treeEntries[i] = TreeEntryResponse{ | ||
| Path: entry.GetPath(), | ||
| Type: entry.GetType(), | ||
| Mode: entry.GetMode(), | ||
| SHA: entry.GetSHA(), | ||
| URL: entry.GetURL(), | ||
| } | ||
| if entry.Size != nil { | ||
| treeEntries[i].Size = entry.Size | ||
| } | ||
| } | ||
| response := TreeResponse{ | ||
| SHA: *tree.SHA, | ||
| Truncated: *tree.Truncated, | ||
| Tree: treeEntries, | ||
| TreeSHA: treeSHA, | ||
| Owner: owner, | ||
| Repo: repo, | ||
| Recursive: recursive, | ||
| Count: len(filteredEntries), | ||
| } | ||
| r, err := json.Marshal(response) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to marshal response: %w", err) | ||
| } | ||
| return mcp.NewToolResultText(string(r)), nil | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.