client_credentials
OAuth client credential extensions for MCP.
Provides OAuth providers for machine-to-machine authentication flows: - ClientCredentialsOAuthProvider: For client_credentials with client_id + client_secret - PrivateKeyJWTOAuthProvider: For client_credentials with private_key_jwt authentication (typically using a pre-built JWT from workload identity federation) - RFC7523OAuthClientProvider: For jwt-bearer grant (RFC 7523 Section 2.1)
ClientCredentialsOAuthProvider
Bases: OAuthClientProvider
OAuth provider for client_credentials grant with client_id + client_secret.
This provider sets client_info directly, bypassing dynamic client registration. Use this when you already have client credentials (client_id and client_secret).
Example
provider = ClientCredentialsOAuthProvider(
server_url="https://api.example.com",
storage=my_token_storage,
client_id="my-client-id",
client_secret="my-client-secret",
)
Source code in src/mcp/client/auth/extensions/client_credentials.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | |
__init__
__init__(
server_url: str,
storage: TokenStorage,
client_id: str,
client_secret: str,
token_endpoint_auth_method: Literal[
"client_secret_basic", "client_secret_post"
] = "client_secret_basic",
scopes: str | None = None,
) -> None
Initialize client_credentials OAuth provider.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
server_url
|
str
|
The MCP server URL. |
required |
storage
|
TokenStorage
|
Token storage implementation. |
required |
client_id
|
str
|
The OAuth client ID. |
required |
client_secret
|
str
|
The OAuth client secret. |
required |
token_endpoint_auth_method
|
Literal['client_secret_basic', 'client_secret_post']
|
Authentication method for token endpoint. Either "client_secret_basic" (default) or "client_secret_post". |
'client_secret_basic'
|
scopes
|
str | None
|
Optional space-separated list of scopes to request. |
None
|
Source code in src/mcp/client/auth/extensions/client_credentials.py
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | |
static_assertion_provider
Create an assertion provider that returns a static JWT token.
Use this when you have a pre-built JWT (e.g., from workload identity federation) that doesn't need the audience parameter.
Example
provider = PrivateKeyJWTOAuthProvider(
server_url="https://api.example.com",
storage=my_token_storage,
client_id="my-client-id",
assertion_provider=static_assertion_provider(my_prebuilt_jwt),
)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
token
|
str
|
The pre-built JWT assertion string. |
required |
Returns:
| Type | Description |
|---|---|
Callable[[str], Awaitable[str]]
|
An async callback suitable for use as an assertion_provider. |
Source code in src/mcp/client/auth/extensions/client_credentials.py
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | |
SignedJWTParameters
Bases: BaseModel
Parameters for creating SDK-signed JWT assertions.
Use create_assertion_provider() to create an assertion provider callback
for use with PrivateKeyJWTOAuthProvider.
Example
jwt_params = SignedJWTParameters(
issuer="my-client-id",
subject="my-client-id",
signing_key=private_key_pem,
)
provider = PrivateKeyJWTOAuthProvider(
server_url="https://api.example.com",
storage=my_token_storage,
client_id="my-client-id",
assertion_provider=jwt_params.create_assertion_provider(),
)
Source code in src/mcp/client/auth/extensions/client_credentials.py
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | |
create_assertion_provider
Create an assertion provider callback for use with PrivateKeyJWTOAuthProvider.
Returns:
| Type | Description |
|---|---|
Callable[[str], Awaitable[str]]
|
An async callback that takes the audience (authorization server issuer URL) |
Callable[[str], Awaitable[str]]
|
and returns a signed JWT assertion. |
Source code in src/mcp/client/auth/extensions/client_credentials.py
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | |
PrivateKeyJWTOAuthProvider
Bases: OAuthClientProvider
OAuth provider for client_credentials grant with private_key_jwt authentication.
Uses RFC 7523 Section 2.2 for client authentication via JWT assertion.
The JWT assertion's audience MUST be the authorization server's issuer identifier
(per RFC 7523bis security updates). The assertion_provider callback receives
this audience value and must return a JWT with that audience.
Option 1: Pre-built JWT via Workload Identity Federation
In production scenarios, the JWT assertion is typically obtained from a workload identity provider (e.g., GCP, AWS IAM, Azure AD):
```python
async def get_workload_identity_token(audience: str) -> str:
# Fetch JWT from your identity provider
# The JWT's audience must match the provided audience parameter
return await fetch_token_from_identity_provider(audience=audience)
provider = PrivateKeyJWTOAuthProvider(
server_url="https://api.example.com",
storage=my_token_storage,
client_id="my-client-id",
assertion_provider=get_workload_identity_token,
)
```
Option 2: Static pre-built JWT
If you have a static JWT that doesn't need the audience parameter:
```python
provider = PrivateKeyJWTOAuthProvider(
server_url="https://api.example.com",
storage=my_token_storage,
client_id="my-client-id",
assertion_provider=static_assertion_provider(my_prebuilt_jwt),
)
```
Option 3: SDK-signed JWT (for testing/simple setups)
For testing or simple deployments, use SignedJWTParameters.create_assertion_provider():
```python
jwt_params = SignedJWTParameters(
issuer="my-client-id",
subject="my-client-id",
signing_key=private_key_pem,
)
provider = PrivateKeyJWTOAuthProvider(
server_url="https://api.example.com",
storage=my_token_storage,
client_id="my-client-id",
assertion_provider=jwt_params.create_assertion_provider(),
)
```
Source code in src/mcp/client/auth/extensions/client_credentials.py
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 | |
__init__
__init__(
server_url: str,
storage: TokenStorage,
client_id: str,
assertion_provider: Callable[[str], Awaitable[str]],
scopes: str | None = None,
) -> None
Initialize private_key_jwt OAuth provider.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
server_url
|
str
|
The MCP server URL. |
required |
storage
|
TokenStorage
|
Token storage implementation. |
required |
client_id
|
str
|
The OAuth client ID. |
required |
assertion_provider
|
Callable[[str], Awaitable[str]]
|
Async callback that takes the audience (authorization
server's issuer identifier) and returns a JWT assertion. Use
|
required |
scopes
|
str | None
|
Optional space-separated list of scopes to request. |
None
|
Source code in src/mcp/client/auth/extensions/client_credentials.py
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | |
JWTParameters
Bases: BaseModel
JWT parameters.
Source code in src/mcp/client/auth/extensions/client_credentials.py
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 | |
RFC7523OAuthClientProvider
Bases: OAuthClientProvider
OAuth client provider for RFC 7523 jwt-bearer grant.
.. deprecated::
Use :class:ClientCredentialsOAuthProvider for client_credentials with
client_id + client_secret, or :class:PrivateKeyJWTOAuthProvider for
client_credentials with private_key_jwt authentication instead.
This provider supports the jwt-bearer authorization grant (RFC 7523 Section 2.1) where the JWT itself is the authorization grant.
Source code in src/mcp/client/auth/extensions/client_credentials.py
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 | |