feat(governance): add rulesets tools in new governance toolset - #2991
Open
SamMorrowDrums wants to merge 1 commit into
Open
feat(governance): add rulesets tools in new governance toolset#2991SamMorrowDrums wants to merge 1 commit into
SamMorrowDrums wants to merge 1 commit into
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
Add a new non-default "governance" toolset (icon: law) with tools for managing GitHub repository rulesets at the repository, organization, and enterprise levels. Read operations are consolidated behind method-dispatch tools to match the current MCP surface: - repository_ruleset_read (get, list, get_rules_for_branch, list_rule_suites, get_rule_suite) - organization_repository_ruleset_read (get, list) Write operations remain single-purpose tools, split by level because each level requires a distinct OAuth scope for scope-challenge accuracy: - create_repository_ruleset (repo) - create_organization_repository_ruleset (admin:org) - create_enterprise_repository_ruleset (admin:enterprise) Adds the read:enterprise and admin:enterprise scopes and the law octicon as shared governance infrastructure. Supersedes #821. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 1e886867-a922-419a-b02c-ac643716aea8
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a non-default governance toolset for repository, organization, and enterprise rulesets.
Changes:
- Adds five ruleset read/create tools.
- Adds enterprise scopes and governance icon metadata.
- Adds tests, snapshots, and generated documentation.
| File | Description |
|---|---|
| README.md | Documents the governance toolset and tools. |
| docs/remote-server.md | Documents the remote governance endpoint. |
| pkg/scopes/scopes.go | Adds enterprise OAuth scopes. |
| pkg/octicons/required_icons.txt | Adds the law icon requirement. |
| pkg/github/tools.go | Registers governance metadata and tools. |
| pkg/github/rulesets.go | Implements ruleset tools and API operations. |
| pkg/github/rulesets_test.go | Tests ruleset schemas and handlers. |
| pkg/github/__toolsnaps__/repository_ruleset_read.snap | Snapshots repository read schema. |
| pkg/github/__toolsnaps__/organization_repository_ruleset_read.snap | Snapshots organization read schema. |
| pkg/github/__toolsnaps__/create_repository_ruleset.snap | Snapshots repository creation schema. |
| pkg/github/__toolsnaps__/create_organization_repository_ruleset.snap | Snapshots organization creation schema. |
| pkg/github/__toolsnaps__/create_enterprise_repository_ruleset.snap | Snapshots enterprise creation schema. |
Review details
- Files reviewed: 12/14 changed files
- Comments generated: 4
- Review effort level: Balanced
Sorry, something went wrong.
Comment thread
pkg/github/rulesets.go
Comment on lines
+714
to
+716
| for _, ruleType := range requestedRuleTypes { | ||
| if !appliedRuleTypes[ruleType] { | ||
| return github.RepositoryRuleset{}, utils.NewToolResultError(fmt.Sprintf("unsupported or unrecognized rule type: %q", ruleType)) |
Comment thread
pkg/github/rulesets.go
Comment on lines
+629
to
+632
| "bypass_mode": { | ||
| Type: "string", | ||
| Enum: []any{"always", "pull_request"}, | ||
| Description: "When the specified actor can bypass the ruleset", |
Comment thread
pkg/github/rulesets.go
Comment on lines
+624
to
+627
| "actor_type": { | ||
| Type: "string", | ||
| Enum: []any{"Integration", "OrganizationAdmin", "RepositoryRole", "Team", "DeployKey"}, | ||
| Description: "The type of actor that can bypass a ruleset", |
Comment thread
pkg/scopes/scopes.go
| User: {ReadUser, UserEmail}, | ||
| Repo: {PublicRepo, SecurityEvents}, | ||
| AdminOrg: {WriteOrg, ReadOrg}, | ||
| AdminEnterprise: {ReadEnterprise}, |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Governance toolset — Rulesets (PR 1 of 2)
Adds a new non-default governance toolset (icon: law) and the first half of its tools: GitHub repository rulesets at the repository, organization, and enterprise levels.
This supersedes the very stale #821 (re: #820), replayed onto the current codebase (modelcontextprotocol/go-sdk, go-github v87) and reshaped to match today's MCP tool surface.
Tools (5)
Design notes
Stack
Verified: script/lint (0 issues), script/test, script/generate-docs all green.