Skip to main content

McpOAuthAuthenticatorParameters

@webda/mcp

Class: McpOAuthAuthenticatorParameters

Defined in: packages/mcp/src/oauth.service.ts:19

McpOAuthAuthenticator parameters

Extends​

  • ServiceParameters

Constructors​

Constructor​

new McpOAuthAuthenticatorParameters(): McpOAuthAuthenticatorParameters

Returns​

McpOAuthAuthenticatorParameters

Inherited from​

ServiceParameters.constructor

Properties​

authorizationServers?​

optional authorizationServers?: string[]

Defined in: packages/mcp/src/oauth.service.ts:24

Authorization servers advertised in the protected resource metadata; defaults to publicUrl when set, otherwise the request origin (with the application prefix)

publicUrl?​

optional publicUrl?: string

Defined in: packages/mcp/src/oauth.service.ts:39

Canonical public origin of the application (absolute, e.g. https://mcp.example.com): the token audience and the advertised resource are derived from it instead of the request headers. Set it in production, notably behind a proxy

resourceMetadataPath​

resourceMetadataPath: string

Defined in: packages/mcp/src/oauth.service.ts:29

Path serving the RFC 9728 protected resource metadata

Default​

"/.well-known/oauth-protected-resource"

scopesSupported?​

optional scopesSupported?: string[]

Defined in: packages/mcp/src/oauth.service.ts:34

Scopes advertised in the protected resource metadata (scopes_supported); defaults to what the Webda authorization server advertises: *, the top-level operation groups (<Group>.*) and offline_access

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: packages/mcp/src/oauth.service.ts:45

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this with defaults applied

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with