This PR introduces client-side OAuth support. # Overall design philosophy The main new interface introduced to support client-side OAuth is the `OAuthHandler`. Contrary to its counter-parts in some other SDKs, it is intentionally small and generic so that it can support most of the OAuth authorization flow variants. The main `mcp` package purposefully delegates almost all auth handling to `OAuthHandler` implementations. This way, the `mcp` package continues to be largely OAuth agnostic. The `auth` package comes with a default `OAuthHandler` implementation – `AuthorizationCodeHandler`, which implements the authorization flow for the `authorization_code` grant type, as defined in the [MCP specification](https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization). It is expected that the `OAuthHandler` implementation granularity will be roughly per grant type, as this parameter influences the authorization flow the most. # Detailed design ## `OAuthHandler` (auth/client.go) The main interface for the integration consists of two methods: ```go type OAuthHandler interface { // TokenSource returns a token source to be used for outgoing requests. // Returned token source might be nil. In that case, the transport will not // add any authorization headers to the request. TokenSource(context.Context) (oauth2.TokenSource, error) // Authorize is called when an HTTP request results in an error that may // be addressed by the authorization flow (currently 401 Unauthorized and 403 Forbidden). // It is responsible for performing the OAuth flow to obtain an access token. // The arguments are the request that failed and the response that was received for it. // The headers of the request are available, but the body will have already been consumed // when Authorize is called. // If the returned error is nil, TokenSource is expected to return a non-nil token source. // After a successful call to Authorize, the HTTP request will be retried by the transport. // The function is responsible for closing the response body. Authorize(context.Context, *http.Request, *http.Response) error } ``` `StreamableClientTransport` accepts this interface as a field and uses the `TokenSource` method to add an `Authorization: Bearer` header to outgoing requests to the MCP server. If the request fails with `401: Unauthorized` or `403: Forbidden`, the transport calls `Authorize` to perform the authorization flow. If `Authorize` returns a non-nil error, the request is retried once. `Authorize` errors do not result in termination of the client session (unless they happen during connection initialization), as some OAuth flows are multi-legged and it should be acceptable to retry for example when the authorization grant was received. *Note:* There was already an `OAuthHandler` type defined as part of a previous iteration of OAuth support. It was renamed to `OAuthHandlerLegacy`. This is the only backwards incompatible API change in the experimental client `auth` part (protected by the `mcp_go_client_oauth` Go build tag). The cost of replacing previous usages is deemed worthwhile to maintain clear naming, under the assumption that the experimental client `auth` part was not widely used. ## `AuthorizationCodeHandler` (auth/authorization_code.go) This is the `OAuthHandler` implementation that fulfills the [MCP specification](https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization). In particular, in supports: - Protected Resource Metadata discovery and fetching - Authorization Server Metadata discovery and fetching - Client registration - OpenID Connect metadata document - Pre-registration - Dynamic Client Registration - PKCE - `client_secret_post`, `client_secret_basic` token endpoint auth methods - Automatic refresh of tokens ### Authorization Server redirect As part of the flow for the `authorization_code` grant type, the client needs to point the user to the authorization URL, so that they confirm the access request. This design proposes that it will be supported via a pluggable dependency that will initiate this process in an application-specific way: ```go type AuthorizationCodeHandler struct { ... // AuthorizationCodeFetcher is a required function called to initiate the authorization flow. // It is responsible for opening the URL in a browser for the user to start the authorization process. // It should return the authorization code and state once the Authorization Server // redirects back to the RedirectURL. AuthorizationCodeFetcher func(ctx context.Context, args *AuthorizationArgs) (*AuthorizationResult, error) ... } ``` The function is supposed perform any application specific logic to handle the redirect from the Authorization Server and return the resulting code and state. ## `oauthex` changes Some additional/adjusted building blocks that may be useful when creating `OAuthHandler` implementations are present in the `oauthex` package: - `auth_meta.go`: Authorization Server Metadata utilities: - `GetAuthServerMeta`: get Authorization Server Metadata from a URL - `dcr.go`: Dynamic Client Registration utilities (unchanged) - `resource_meta.go`: Protected Resource Metadata utilities: - `GetProtectedResourceMetadata`: get Protected Resource Metadata from a URL - `ParseWWWAuthenticate` – as per name (unchanged) - [deprecated] `GetProtectedResourceMetadataFromID` and `GetProtectedResourceMetadataFromHeader` in favor of more generic `GetProtectedResourceMetadata`. They will be kept under the Go build tag and removed one version of the SDK in the future.
167 lines
4.3 KiB
Go
167 lines
4.3 KiB
Go
// Copyright 2026 The Go MCP SDK Authors. All rights reserved.
|
|
// Use of this source code is governed by the license
|
|
// that can be found in the LICENSE file.
|
|
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"flag"
|
|
"fmt"
|
|
"log"
|
|
"net/http"
|
|
"net/http/httputil"
|
|
"net/url"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/modelcontextprotocol/go-sdk/auth"
|
|
"github.com/modelcontextprotocol/go-sdk/mcp"
|
|
"github.com/modelcontextprotocol/go-sdk/oauthex"
|
|
)
|
|
|
|
// Flags.
|
|
var (
|
|
port = flag.Int("port", 8000, "Port to listen on")
|
|
)
|
|
|
|
// Configuration required for this example.
|
|
var (
|
|
// Authorization server to return in the protected resource metadata.
|
|
authorizationServer = ""
|
|
// Introspection endpoint for verifying tokens.
|
|
introspectionEndpoint = ""
|
|
// Client credentials used in the introspection request.
|
|
clientID = ""
|
|
clientSecret = ""
|
|
)
|
|
|
|
func verifyToken(ctx context.Context, token string, _ *http.Request) (*auth.TokenInfo, error) {
|
|
data := url.Values{}
|
|
data.Set("token", token)
|
|
data.Set("token_type_hint", "access_token")
|
|
|
|
req, err := http.NewRequestWithContext(ctx, "POST", introspectionEndpoint, strings.NewReader(data.Encode()))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
|
|
req.Header.Set("Accept", "application/json")
|
|
req.SetBasicAuth(clientID, clientSecret)
|
|
|
|
resp, err := http.DefaultClient.Do(req)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
if resp.StatusCode != http.StatusOK {
|
|
dump, _ := httputil.DumpResponse(resp, true)
|
|
log.Printf("Introspection failed: %s", dump)
|
|
return nil, fmt.Errorf("introspection failed with status %d", resp.StatusCode)
|
|
}
|
|
|
|
var result struct {
|
|
Active bool `json:"active"`
|
|
Scope string `json:"scope"`
|
|
Exp int64 `json:"exp"`
|
|
Sub string `json:"sub"`
|
|
}
|
|
if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if !result.Active {
|
|
return nil, auth.ErrInvalidToken
|
|
}
|
|
|
|
return &auth.TokenInfo{
|
|
Scopes: strings.Fields(result.Scope),
|
|
Expiration: time.Unix(result.Exp, 0),
|
|
UserID: result.Sub,
|
|
}, nil
|
|
}
|
|
|
|
type args struct {
|
|
Input string `json:"input"`
|
|
}
|
|
|
|
func echo(ctx context.Context, req *mcp.CallToolRequest, args args) (*mcp.CallToolResult, any, error) {
|
|
return &mcp.CallToolResult{
|
|
Content: []mcp.Content{
|
|
&mcp.TextContent{Text: args.Input},
|
|
},
|
|
}, nil, nil
|
|
}
|
|
|
|
func main() {
|
|
flag.Parse()
|
|
metadata := &oauthex.ProtectedResourceMetadata{
|
|
Resource: fmt.Sprintf("http://localhost:%d/mcp", *port),
|
|
AuthorizationServers: []string{authorizationServer},
|
|
ScopesSupported: []string{"read"},
|
|
}
|
|
http.Handle("/.well-known/oauth-protected-resource", auth.ProtectedResourceMetadataHandler(metadata))
|
|
|
|
server := mcp.NewServer(&mcp.Implementation{
|
|
Name: "test-server",
|
|
Version: "1.0.0",
|
|
}, nil)
|
|
server.AddReceivingMiddleware(createLoggingMiddleware())
|
|
mcp.AddTool(server, &mcp.Tool{Name: "echo"}, echo)
|
|
|
|
handler := mcp.NewStreamableHTTPHandler(func(req *http.Request) *mcp.Server {
|
|
return server
|
|
}, nil)
|
|
|
|
authMiddleware := auth.RequireBearerToken(verifyToken, &auth.RequireBearerTokenOptions{
|
|
Scopes: []string{"read"},
|
|
ResourceMetadataURL: fmt.Sprintf("http://localhost:%d/.well-known/oauth-protected-resource", *port),
|
|
})
|
|
|
|
http.Handle("/mcp", authMiddleware(handler))
|
|
|
|
log.Printf("Starting server on http://localhost:%d", *port)
|
|
log.Fatal(http.ListenAndServe(fmt.Sprintf("localhost:%d", *port), nil))
|
|
}
|
|
|
|
// createLoggingMiddleware creates an MCP middleware that logs method calls.
|
|
func createLoggingMiddleware() mcp.Middleware {
|
|
return func(next mcp.MethodHandler) mcp.MethodHandler {
|
|
return func(
|
|
ctx context.Context,
|
|
method string,
|
|
req mcp.Request,
|
|
) (mcp.Result, error) {
|
|
start := time.Now()
|
|
sessionID := req.GetSession().ID()
|
|
|
|
// Log request details.
|
|
log.Printf("[REQUEST] Session: %s | Method: %s",
|
|
sessionID,
|
|
method)
|
|
|
|
// Call the actual handler.
|
|
result, err := next(ctx, method, req)
|
|
|
|
// Log response details.
|
|
duration := time.Since(start)
|
|
|
|
if err != nil {
|
|
log.Printf("[RESPONSE] Session: %s | Method: %s | Status: ERROR | Duration: %v | Error: %v",
|
|
sessionID,
|
|
method,
|
|
duration,
|
|
err)
|
|
} else {
|
|
log.Printf("[RESPONSE] Session: %s | Method: %s | Status: OK | Duration: %v",
|
|
sessionID,
|
|
method,
|
|
duration)
|
|
}
|
|
|
|
return result, err
|
|
}
|
|
}
|
|
}
|