-
Notifications
You must be signed in to change notification settings - Fork 707
Add ScopeSelectorDelegate to enhance OAuth options for scope filtering #1596
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
halllo
wants to merge
3
commits into
modelcontextprotocol:main
Choose a base branch
from
halllo:scope_selector
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.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
37 changes: 37 additions & 0 deletions
37
src/ModelContextProtocol.Core/Authentication/ScopeSelectorDelegate.cs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
|
|
||
| namespace ModelContextProtocol.Authentication; | ||
|
|
||
| /// <summary> | ||
| /// Represents a method that selects or filters the OAuth scopes to request during authorization. | ||
| /// </summary> | ||
| /// <param name="scope"> | ||
| /// The scopes determined by the MCP scope selection strategy (WWW-Authenticate header scope → | ||
| /// <c>scopes_supported</c> from Protected Resource Metadata → <see cref="ClientOAuthOptions.Scopes"/> | ||
| /// fallback), with <c>offline_access</c> appended when advertised by the authorization server. May be | ||
| /// <see langword="null"/> if the server provided no scope information and no fallback scopes are configured. | ||
| /// </param> | ||
| /// <returns> | ||
| /// The scopes to include in the authorization and Dynamic Client Registration requests. Return | ||
| /// <see langword="null"/> or an empty enumerable to omit the <c>scope</c> parameter entirely. | ||
| /// </returns> | ||
| /// <remarks> | ||
| /// <para> | ||
| /// Use this delegate to filter or customize the proposed scopes before the authorization request is made. | ||
| /// Common scenarios include: | ||
| /// </para> | ||
| /// <list type="bullet"> | ||
| /// <item><description>Requesting only a subset of the scopes offered by the server.</description></item> | ||
| /// <item><description>Appending a custom scope not advertised in the server metadata.</description></item> | ||
| /// </list> | ||
| /// <para> | ||
| /// The MCP specification defines the following scope selection priority (highest to lowest): | ||
| /// WWW-Authenticate header scope → PRM <c>scopes_supported</c> → omit scope parameter. The | ||
| /// <paramref name="scope"/> parameter already reflects this priority. The delegate runs after | ||
| /// <c>offline_access</c> has been auto-appended, so it can also remove that scope if desired. | ||
| /// </para> | ||
| /// <para> | ||
| /// The resolved scope is applied consistently to both the authorization URL and the Dynamic Client | ||
| /// Registration (DCR) request, so the registered client scope matches what is actually requested. | ||
| /// </para> | ||
| /// </remarks> | ||
| public delegate IEnumerable<string>? ScopeSelectorDelegate(IReadOnlyCollection<string>? scope); |
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.