Skip to content

feat: Add OAuth scopes to tool metadata (Phase 1) #1485

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
SamMorrowDrums wants to merge 7 commits into
base: main
Choose a base branch
from
+2,169 −324
Open

feat: Add OAuth scopes to tool metadata (Phase 1) #1485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c6f31f3
feat: Add OAuth scopes to tool metadata
SamMorrowDrums Nov 25, 2025
eac0ea7
feat: Add NewToolsetGroupFromTools constructor
SamMorrowDrums Dec 13, 2025
06655a0
refactor: Use ToolsetMetadata directly in NewToolMeta and NewToolsetG…
SamMorrowDrums Dec 13, 2025
2f0ef4a
feat: Add ToolsetRegistry with scope-aware NewToolsetGroup
SamMorrowDrums Dec 13, 2025
6ce742d
refactor: Use ToolsetRegistry pattern for DefaultToolsetGroup
SamMorrowDrums Dec 13, 2025
689380b
refactor: Rename AvailableTools() to AvailableToolsets()
SamMorrowDrums Dec 13, 2025
d87f53a
feat: Add Meta support for resources and prompts in ToolsetRegistry
SamMorrowDrums Dec 13, 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
182 changes: 91 additions & 91 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 17 additions & 1 deletion cmd/github-mcp-server/generate_docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/github/github-mcp-server/pkg/github"
"github.com/github/github-mcp-server/pkg/lockdown"
"github.com/github/github-mcp-server/pkg/raw"
"github.com/github/github-mcp-server/pkg/scopes"
"github.com/github/github-mcp-server/pkg/toolsets"
"github.com/github/github-mcp-server/pkg/translations"
gogithub "github.com/google/go-github/v79/github"
Expand Down Expand Up @@ -224,7 +225,22 @@ func generateToolDoc(tool mcp.Tool) string {
var lines []string

// Tool name only (using annotation name instead of verbose description)
lines = append(lines, fmt.Sprintf("- **%s** - %s", tool.Name, tool.Annotations.Title))
toolLine := fmt.Sprintf("- **%s** - %s", tool.Name, tool.Annotations.Title)

// Add required scopes if present (skip NoScope which is empty string)
if tool.Meta != nil {
toolScopes := scopes.GetScopesFromMeta(tool.Meta)
var scopeStrs []string
for _, s := range toolScopes {
if s != scopes.NoScope {
scopeStrs = append(scopeStrs, fmt.Sprintf("`%s`", s.String()))
}
}
if len(scopeStrs) > 0 {
toolLine += fmt.Sprintf(" (scopes: %s)", strings.Join(scopeStrs, ", "))
}
}
lines = append(lines, toolLine)

// Parameters
if tool.InputSchema == nil {
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/add_comment_to_pending_review.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "pull_requests"
},
"annotations": {
"title": "Add review comment to the requester's latest pending pull request review"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/add_issue_comment.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "issues"
},
"annotations": {
"title": "Add comment to issue"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/add_project_item.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"project"
],
"toolset": "projects"
},
"annotations": {
"title": "Add project item"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/assign_copilot_to_issue.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "issues"
},
"annotations": {
"idempotentHint": true,
"title": "Assign Copilot to issue"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/cancel_workflow_run.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "actions"
},
"annotations": {
"title": "Cancel workflow run"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/create_branch.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "repos"
},
"annotations": {
"title": "Create branch"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/create_gist.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"gist"
],
"toolset": "gists"
},
"annotations": {
"title": "Create Gist"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/create_or_update_file.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "repos"
},
"annotations": {
"title": "Create or update file"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/create_pull_request.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "pull_requests"
},
"annotations": {
"title": "Open new pull request"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/create_repository.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "repos"
},
"annotations": {
"title": "Create repository"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/delete_file.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "repos"
},
"annotations": {
"destructiveHint": true,
"title": "Delete file"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/delete_project_item.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"project"
],
"toolset": "projects"
},
"annotations": {
"title": "Delete project item"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/delete_workflow_run_logs.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "actions"
},
"annotations": {
"destructiveHint": true,
"title": "Delete workflow logs"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/dismiss_notification.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"notifications"
],
"toolset": "notifications"
},
"annotations": {
"title": "Dismiss notification"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/download_workflow_run_artifact.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "actions"
},
"annotations": {
"readOnlyHint": true,
"title": "Download workflow artifact"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/fork_repository.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "repos"
},
"annotations": {
"title": "Fork repository"
},
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_code_scanning_alert.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"security_events"
],
"toolset": "code_security"
},
"annotations": {
"readOnlyHint": true,
"title": "Get code scanning alert"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_commit.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "repos"
},
"annotations": {
"readOnlyHint": true,
"title": "Get commit details"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_dependabot_alert.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"security_events"
],
"toolset": "dependabot"
},
"annotations": {
"readOnlyHint": true,
"title": "Get dependabot alert"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_discussion.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "discussions"
},
"annotations": {
"readOnlyHint": true,
"title": "Get discussion"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_discussion_comments.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "discussions"
},
"annotations": {
"readOnlyHint": true,
"title": "Get discussion comments"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_file_contents.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "repos"
},
"annotations": {
"readOnlyHint": true,
"title": "Get file or directory contents"
Expand Down
3 changes: 3 additions & 0 deletions pkg/github/__toolsnaps__/get_gist.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"_meta": {
"toolset": "gists"
},
"annotations": {
"readOnlyHint": true,
"title": "Get Gist Content"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_global_security_advisory.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"security_events"
],
"toolset": "security_advisories"
},
"annotations": {
"readOnlyHint": true,
"title": "Get a global security advisory"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_job_logs.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "actions"
},
"annotations": {
"readOnlyHint": true,
"title": "Get job logs"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_label.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "labels"
},
"annotations": {
"readOnlyHint": true,
"title": "Get a specific label from a repository."
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_latest_release.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "repos"
},
"annotations": {
"readOnlyHint": true,
"title": "Get latest release"
Expand Down
3 changes: 3 additions & 0 deletions pkg/github/__toolsnaps__/get_me.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"_meta": {
"toolset": "context"
},
"annotations": {
"readOnlyHint": true,
"title": "Get my user profile"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_notification_details.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"notifications"
],
"toolset": "notifications"
},
"annotations": {
"readOnlyHint": true,
"title": "Get notification details"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_project.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"read:project"
],
"toolset": "projects"
},
"annotations": {
"readOnlyHint": true,
"title": "Get project"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_project_field.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"read:project"
],
"toolset": "projects"
},
"annotations": {
"readOnlyHint": true,
"title": "Get project field"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_project_item.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"read:project"
],
"toolset": "projects"
},
"annotations": {
"readOnlyHint": true,
"title": "Get project item"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_release_by_tag.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "repos"
},
"annotations": {
"readOnlyHint": true,
"title": "Get a release by tag name"
Expand Down
6 changes: 6 additions & 0 deletions pkg/github/__toolsnaps__/get_repository_tree.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"_meta": {
"requiredOAuthScopes": [
"repo"
],
"toolset": "git"
},
"annotations": {
"readOnlyHint": true,
"title": "Get repository tree"
Expand Down
Loading
Loading