Skip to main content

McpServiceParameters

@webda/mcp

Class: McpServiceParameters

Defined in: packages/mcp/src/mcpservice.service.ts:32

Parameters for the MCP transport

Extends​

  • OperationsTransportParameters

Constructors​

Constructor​

new McpServiceParameters(): McpServiceParameters

Returns​

McpServiceParameters

Inherited from​

OperationsTransportParameters.constructor

Properties​

allowedHosts​

allowedHosts: string[]

Defined in: packages/mcp/src/mcpservice.service.ts:66

Hostnames (any port) accepted in the request Host, against DNS rebinding; "*" disables the check

Default​

["localhost","127.0.0.1","::1"]

allowedOrigins​

allowedOrigins: string[]

Defined in: packages/mcp/src/mcpservice.service.ts:60

Extra Origin values accepted besides the request's own origin

Default​

[]

authenticator?​

optional authenticator?: string

Defined in: packages/mcp/src/mcpservice.service.ts:99

Name of a service implementing McpAuthenticator; default uses the Webda session

listOutOfScopeTools​

listOutOfScopeTools: boolean

Defined in: packages/mcp/src/mcpservice.service.ts:105

List the tools the token scope does not cover in tools/list; calling them still answers insufficient_scope so the client can ask for a wider grant

Default​

false

maxOutputBytes​

maxOutputBytes: number

Defined in: packages/mcp/src/mcpservice.service.ts:77

Larger tool/resource outputs are truncated

Default​

1048576

maxSessions​

maxSessions: number

Defined in: packages/mcp/src/mcpservice.service.ts:72

Maximum number of concurrent MCP HTTP sessions; at the limit the least recently used session is closed to make room for a new one

Default​

1000

operations?​

optional operations?: string[]

Defined in: packages/core/lib/services/operationstransport.d.ts:26

List of operations to include/exclude Supports wildcards and negation: ["*", "!User.Delete"]

Default​

["*"]

Inherited from​

OperationsTransportParameters.operations

resources​

resources: false | { models: string[]; }

Defined in: packages/mcp/src/mcpservice.service.ts:42

Models exposed as resources (short ids or "*"); false disables resources

Union Members​

false

Type Literal​

{ models: string[]; }

models​

models: string[]

Models exposed as resources

Default​
["*"]

Default​

{"models":["*"]}

serverName?​

optional serverName?: string

Defined in: packages/mcp/src/mcpservice.service.ts:81

Server name announced to clients (defaults to the application package name)

serverVersion?​

optional serverVersion?: string

Defined in: packages/mcp/src/mcpservice.service.ts:85

Server version announced to clients (defaults to the application package version)

sessionTimeout​

sessionTimeout: number

Defined in: packages/mcp/src/mcpservice.service.ts:55

Seconds of inactivity before an MCP session is evicted

Default​

1800

stdio​

stdio: object

Defined in: packages/mcp/src/mcpservice.service.ts:90

stdio defaults

user?​

optional user?: string

Default user for webda mcp

Default​

{}

type​

type: string

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

Type of the service

Inherited from​

OperationsTransportParameters.type

url​

url: string | false

Defined in: packages/mcp/src/mcpservice.service.ts:37

HTTP endpoint; false disables HTTP (stdio only)

Default​

"/mcp"

Methods​

isIncluded()​

isIncluded(operationId): boolean

Defined in: packages/core/lib/services/operationstransport.d.ts:50

Check if an operation is included by this transport

Parameters​

operationId​

string

the operation identifier

Returns​

boolean

true if the operation is included

Inherited from​

OperationsTransportParameters.isIncluded

load()​

load(params?): this

Defined in: packages/mcp/src/mcpservice.service.ts:111

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this with defaults applied

Overrides​

OperationsTransportParameters.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​

OperationsTransportParameters.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​

OperationsTransportParameters.with