Skip to content

Document ClientOAuthOptions.ScopeSelector usage #1869

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
z0rimo wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −0
Open

Document ClientOAuthOptions.ScopeSelector usage #1869

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
23 changes: 23 additions & 0 deletions docs/concepts/transports/transports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,29 @@ var transport = new HttpClientTransport(new HttpClientTransportOptions
});
```

#### OAuth scope selection

When OAuth is configured through <xref:ModelContextProtocol.Client.HttpClientTransportOptions.OAuth>, <xref:ModelContextProtocol.Authentication.ClientOAuthOptions.Scopes> provides fallback scopes only when the server does not provide scope information through the `WWW-Authenticate` header or Protected Resource Metadata.

To filter or customize the scopes selected from server-provided information, use <xref:ModelContextProtocol.Authentication.ClientOAuthOptions.ScopeSelector>. The selector runs after the SDK has resolved the candidate scopes and appended `offline_access` when advertised by the authorization server. The returned scopes are used consistently for the authorization request and Dynamic Client Registration.

```csharp
using ModelContextProtocol.Authentication;

var transport = new HttpClientTransport(new HttpClientTransportOptions
{
Endpoint = new Uri("https://my-mcp-server.example.com/mcp"),
OAuth = new ClientOAuthOptions
{
RedirectUri = new Uri("http://localhost:1179/callback"),
ScopeSelector = scopes =>
scopes?.Where(scope => scope is "mcp:tools" or "mcp:resources")
}
});
```

Return `null` or an empty sequence from `ScopeSelector` to omit the `scope` parameter entirely.

#### Resuming sessions

Streamable HTTP supports session resumption. Save the session ID, server capabilities, and server info from the original session, then use <xref:ModelContextProtocol.Client.McpClient.ResumeSessionAsync*> to reconnect:
Expand Down