MCP TypeScript SDK (V2) / @modelcontextprotocol/server-legacy / auth/middleware/bearerAuth

auth/middleware/bearerAuth

Type Aliases

BearerAuthMiddlewareOptions

BearerAuthMiddlewareOptions = object

Defined in: packages/server-legacy/src/auth/middleware/bearerAuth.ts:7

Properties

expectedResource?

optional expectedResource?: URL

Defined in: packages/server-legacy/src/auth/middleware/bearerAuth.ts:28

Optional resource the token must be issued for (its audience), usually the server's URL. When set, the verifier has to report this value in AuthInfo.resource (a fragment and one trailing slash are ignored); any other token is refused with 401 invalid_token.

requiredScopes?

optional requiredScopes?: string[]

Defined in: packages/server-legacy/src/auth/middleware/bearerAuth.ts:16

Optional scopes that the token must have.

resourceMetadataUrl?

optional resourceMetadataUrl?: string

Defined in: packages/server-legacy/src/auth/middleware/bearerAuth.ts:21

Optional resource metadata URL to include in WWW-Authenticate header.

verifier

verifier: OAuthTokenVerifier

Defined in: packages/server-legacy/src/auth/middleware/bearerAuth.ts:11

A provider used to verify tokens.

Functions

requireBearerAuth()

requireBearerAuth(__namedParameters): RequestHandler

Defined in: packages/server-legacy/src/auth/middleware/bearerAuth.ts:61

Middleware that requires a valid Bearer token in the Authorization header.

This will validate the token with the auth provider and add the resulting auth info to the request object.

If resourceMetadataUrl is provided, it will be included in the WWW-Authenticate header for 401 responses as per the OAuth 2.0 Protected Resource Metadata spec.

Parameters

__namedParameters

BearerAuthMiddlewareOptions

Returns

RequestHandler