Skip to content

docs: document PR resource URI template and add corresponding test #668

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 2 commits into from
Closed

docs: document PR resource URI template and add corresponding test #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdd45e3
Initial plan
Copilot Jul 11, 2025
3553c37
docs: add resource URI templates for PR resources
Copilot Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1001,6 +1001,29 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description

The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.

## Resource URI Templates

The GitHub MCP Server supports accessing repository file contents via resource URI templates. These templates use the `repo://` scheme to reference repository contents for different Git references:

```text
repo://{owner}/{repo}/contents{/path*}
repo://{owner}/{repo}/refs/heads/{branch}/contents{/path*}
repo://{owner}/{repo}/sha/{sha}/contents{/path*}
repo://{owner}/{repo}/refs/tags/{tag}/contents{/path*}
repo://{owner}/{repo}/refs/pull/{prNumber}/head/contents{/path*}
```

- **owner**: Repository owner (e.g., `octocat`).
- **repo**: Repository name (e.g., `Hello-World`).
- **branch**, **tag**, **sha**, **prNumber**: Git reference (branch name, tag name, commit SHA, or pull request number).
- **path**: File path relative to the repository root (one or more segments). Must specify a file, not a directory.

Example: To fetch `README.md` from the head commit of pull request #42 in the `octocat/Hello-World` repository:

```text
repo://octocat/Hello-World/refs/pull/42/head/contents/README.md
```

## License

This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
6 changes: 6 additions & 0 deletions pkg/github/repository_resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,9 @@ func Test_GetRepositoryResourceTagContent(t *testing.T) {
tmpl, _ := GetRepositoryResourceTagContent(nil, stubGetRawClientFn(mockRawClient), translations.NullTranslationHelper)
require.Equal(t, "repo://{owner}/{repo}/refs/tags/{tag}/contents{/path*}", tmpl.URITemplate.Raw())
}

func Test_GetRepositoryResourcePrContent(t *testing.T) {
mockRawClient := raw.NewClient(github.NewClient(nil), &url.URL{})
tmpl, _ := GetRepositoryResourcePrContent(nil, stubGetRawClientFn(mockRawClient), translations.NullTranslationHelper)
require.Equal(t, "repo://{owner}/{repo}/refs/pull/{prNumber}/head/contents{/path*}", tmpl.URITemplate.Raw())
}
Loading