- Notifications
You must be signed in to change notification settings - Fork1.2k
fix(tools): Ensure get_file_contents returns file SHA#599
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
yonaka15 wants to merge2 commits intogithub:mainChoose 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.
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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
The previous implementation of `get_file_contents` had two issues:1. When fetching a file, it used the raw content endpoint, which does not provide the file's SHA.2. When fetching a directory, it returned a raw JSON array, which was not easily parsable by the agent.This commit refactors the `get_file_contents` tool to always use the `client.Repositories.GetContents` method. This method returns a `RepositoryContent` object (or a slice of them for directories), which always includes the SHA and other metadata.The function now marshals this object (or slice) into a JSON string, providing a consistent and parsable output that includes the necessary SHA for subsequent file operations.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Pull Request Overview
This PR ensures theget_file_contents tool includes the file SHA in its response and cleans up the implementation. Key changes include:
- Added the
shafield to theFileContentstruct and propagate it throughGetFileContents. - Removed the raw content fallback logic for simplicity.
- Standardized error handling using
fmt.Errorfand GitHub API error wrappers.
Comments suppressed due to low confidence (4)
pkg/github/repositories.go:550
- Now that SHA is included in the
result, consider adding automated tests to verify thatGetFileContentsproperly populatesshafor file responses and that directory responses remain unchanged.
r, err := json.Marshal(result)pkg/github/repositories.go:515
- This return uses a generic
fmt.Errorfinstead of wrapping the error in an MCP tool result (e.g.,mcp.NewToolResultError). Consider returning a consistentToolResulterror so callers receive the standardized error structure.
return nil, fmt.Errorf("failed to get GitHub client: %w", err)pkg/github/repositories.go:536
- Similar to the client error above, this returns a raw
fmt.Errorf. To maintain consistent tool output, wrap this inmcp.NewToolResultErrorinstead of returning a plain error.
return nil, fmt.Errorf("failed to read response body: %w", err)pkg/github/repositories.go:552
- This marshal error is returned as a plain error. For uniform tool behavior, return
mcp.NewToolResultErrorwith the error message.
return nil, fmt.Errorf("failed to marshal response: %w", err)Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
1 participant
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.
This PR addresses the issue where the
get_file_contentstool fails to return the SHA hash of the file content. The SHA is a crucial piece of metadata, especially for subsequent update operations which require it.What was the problem?
The
get_file_contentstool's response struct did not include theshafield from the GitHub API response, making it impossible to get a file's SHA through the tool. This breaks workflows that need to read a file and then update it, ascreate_or_update_filerequires the blob's SHA.How does this PR fix it?
The
FileContentstruct inpkg/github/content.gohas been updated to include theSHAfield. TheGetFileContentsfunction now correctly populates this field from the GitHub API response.Verification
This change was manually verified in a sandbox environment. By calling the
get_file_contentstool via the@modelcontextprotocol/inspector, I confirmed that the JSON response now correctly includes the"sha"key and its corresponding value.This change is backward-compatible as it only adds a field to the response.
Fixes#595