Skip to content

fix(scopes): allow public_repo scope for public repository write tools #3150

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

Open
CAOShurong wants to merge 1 commit into
base: main
Choose a base branch
from
+95 −6
Open

fix(scopes): allow public_repo scope for public repository write tools #3150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions pkg/github/issues.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1401,7 +1401,7 @@ func AddIssueComment(t translations.TranslationHelperFunc) inventory.ServerTool
Required: []string{"owner", "repo", "issue_number"},
},
},
[]scopes.Scope{scopes.Repo},
[]scopes.Scope{scopes.PublicRepo},
func(ctx context.Context, deps ToolDependencies, _ *mcp.CallToolRequest, args map[string]any) (*mcp.CallToolResult, any, error) {
owner, err := RequiredParam[string](args, "owner")
if err != nil {
Expand Down Expand Up @@ -2511,7 +2511,7 @@ Options are:
Required: []string{"method", "owner", "repo"},
},
},
[]scopes.Scope{scopes.Repo},
[]scopes.Scope{scopes.PublicRepo},
func(ctx context.Context, deps ToolDependencies, req *mcp.CallToolRequest, args map[string]any) (*mcp.CallToolResult, any, error) {
method, err := RequiredParam[string](args, "method")
if err != nil {
Expand Down
89 changes: 89 additions & 0 deletions pkg/github/public_repo_scope_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
package github

import (
"testing"

"github.com/github/github-mcp-server/pkg/inventory"
"github.com/github/github-mcp-server/pkg/scopes"
"github.com/github/github-mcp-server/pkg/translations"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

// TestPublicRepoWriteToolsDeclareLeastPrivilegeScopes asserts that the public
// repository write tools advertise `public_repo` as their required scope while
// still accepting a full `repo` token (via the scope hierarchy). This enables
// least-privilege, public-only OAuth deployments instead of forcing the broad
// `repo` scope, which also grants private-repository access.
// See https://github.com/github/github-mcp-server/issues/3136
func TestPublicRepoWriteToolsDeclareLeastPrivilegeScopes(t *testing.T) {
t.Parallel()

builders := map[string]func(translations.TranslationHelperFunc) *inventory.ServerTool{
"add_issue_comment": wrapToolBuilder(AddIssueComment),
"issue_write": wrapToolBuilder(IssueWrite),
"create_branch": wrapToolBuilder(CreateBranch),
"push_files": wrapToolBuilder(PushFiles),
"create_pull_request": wrapToolBuilder(CreatePullRequest),
"fork_repository": wrapToolBuilder(ForkRepository),
}

for name, build := range builders {
t.Run(name, func(t *testing.T) {
t.Parallel()

st := build(translations.NullTranslationHelper)

assert.Equal(t, []string{string(scopes.PublicRepo)}, st.RequiredScopes,
"%s should require only public_repo", name)
assert.ElementsMatch(t,
[]string{string(scopes.PublicRepo), string(scopes.Repo)}, st.AcceptedScopes,
"%s should accept both public_repo and repo tokens", name)
})
}
}

// TestPublicRepoWriteToolsVisibleToPublicRepoToken asserts the PAT tool filter
// shows these tools to a public_repo-only token and keeps them visible for a
// full repo token.
func TestPublicRepoWriteToolsVisibleToPublicRepoToken(t *testing.T) {
t.Parallel()

publicRepoToken := []string{string(scopes.PublicRepo)}
repoToken := []string{string(scopes.Repo)}

filterForPublicToken := CreateToolScopeFilter(publicRepoToken)
filterForRepoToken := CreateToolScopeFilter(repoToken)

builders := map[string]func(translations.TranslationHelperFunc) *inventory.ServerTool{
"add_issue_comment": wrapToolBuilder(AddIssueComment),
"issue_write": wrapToolBuilder(IssueWrite),
"create_branch": wrapToolBuilder(CreateBranch),
"push_files": wrapToolBuilder(PushFiles),
"create_pull_request": wrapToolBuilder(CreatePullRequest),
"fork_repository": wrapToolBuilder(ForkRepository),
}

for name, build := range builders {
t.Run(name, func(t *testing.T) {
t.Parallel()

st := build(translations.NullTranslationHelper)

allowed, err := filterForPublicToken(t.Context(), st)
require.NoError(t, err)
assert.True(t, allowed, "%s should be visible with a public_repo-only token", name)

allowed, err = filterForRepoToken(t.Context(), st)
require.NoError(t, err)
assert.True(t, allowed, "%s should remain visible with a full repo token", name)
})
}
}

func wrapToolBuilder(fn func(translations.TranslationHelperFunc) inventory.ServerTool) func(translations.TranslationHelperFunc) *inventory.ServerTool {
return func(t translations.TranslationHelperFunc) *inventory.ServerTool {
st := fn(t)
return &st
}
}
2 changes: 1 addition & 1 deletion pkg/github/pullrequests.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@ func CreatePullRequest(t translations.TranslationHelperFunc) inventory.ServerToo
Required: []string{"owner", "repo", "title", "head", "base"},
},
},
[]scopes.Scope{scopes.Repo},
[]scopes.Scope{scopes.PublicRepo},
func(ctx context.Context, deps ToolDependencies, req *mcp.CallToolRequest, args map[string]any) (*mcp.CallToolResult, any, error) {
owner, err := RequiredParam[string](args, "owner")
if err != nil {
Expand Down
6 changes: 3 additions & 3 deletions pkg/github/repositories.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1222,7 +1222,7 @@ func ForkRepository(t translations.TranslationHelperFunc) inventory.ServerTool {
Required: []string{"owner", "repo"},
},
},
[]scopes.Scope{scopes.Repo},
[]scopes.Scope{scopes.PublicRepo},
func(ctx context.Context, deps ToolDependencies, _ *mcp.CallToolRequest, args map[string]any) (*mcp.CallToolResult, any, error) {
owner, err := RequiredParam[string](args, "owner")
if err != nil {
Expand Down Expand Up @@ -1509,7 +1509,7 @@ func CreateBranch(t translations.TranslationHelperFunc) inventory.ServerTool {
Required: []string{"owner", "repo", "branch"},
},
},
[]scopes.Scope{scopes.Repo},
[]scopes.Scope{scopes.PublicRepo},
func(ctx context.Context, deps ToolDependencies, _ *mcp.CallToolRequest, args map[string]any) (*mcp.CallToolResult, any, error) {
owner, err := RequiredParam[string](args, "owner")
if err != nil {
Expand Down Expand Up @@ -1641,7 +1641,7 @@ func PushFiles(t translations.TranslationHelperFunc) inventory.ServerTool {
Required: []string{"owner", "repo", "branch", "files", "message"},
},
},
[]scopes.Scope{scopes.Repo},
[]scopes.Scope{scopes.PublicRepo},
func(ctx context.Context, deps ToolDependencies, _ *mcp.CallToolRequest, args map[string]any) (*mcp.CallToolResult, any, error) {
owner, err := RequiredParam[string](args, "owner")
if err != nil {
Expand Down