Skip to main content
Defined in: server/context.ts:79

Properties

auth

auth: AccessToken | undefined;
Defined in: server/context.ts:81 Auth token for the current request, if any.

requestId

requestId: string | undefined;
Defined in: server/context.ts:83 The MCP request ID for the current call.

Methods

alert()

alert(message, loggerName?): Promise<void>;
Defined in: server/context.ts:95

Parameters

message
string
loggerName?
string

Returns

Promise<void>

critical()

critical(message, loggerName?): Promise<void>;
Defined in: server/context.ts:94

Parameters

message
string
loggerName?
string

Returns

Promise<void>

debug()

debug(message, loggerName?): Promise<void>;
Defined in: server/context.ts:89

Parameters

message
string
loggerName?
string

Returns

Promise<void>

deleteState()

deleteState(key): void;
Defined in: server/context.ts:137 Remove a value from session-scoped state.

Parameters

key
string

Returns

void

elicit()

elicit(message, schema): Promise<ElicitationResult>;
Defined in: server/context.ts:120 Ask the client to collect input from the user via a form dialog. Throws if the client has not advertised the elicitation capability.

Parameters

message
string
schema
ElicitationSchema

Returns

Promise<ElicitationResult>

emergency()

emergency(message, loggerName?): Promise<void>;
Defined in: server/context.ts:96

Parameters

message
string
loggerName?
string

Returns

Promise<void>

error()

error(message, loggerName?): Promise<void>;
Defined in: server/context.ts:93

Parameters

message
string
loggerName?
string

Returns

Promise<void>

getState()

getState(key): unknown;
Defined in: server/context.ts:133 Retrieve a value from session-scoped state. Returns undefined if not set.

Parameters

key
string

Returns

unknown

info()

info(message, loggerName?): Promise<void>;
Defined in: server/context.ts:90

Parameters

message
string
loggerName?
string

Returns

Promise<void>

listRoots()

listRoots(): Promise<Root[]>;
Defined in: server/context.ts:128 Request the list of filesystem roots the client has declared. Throws if the client has not advertised the roots capability.

Returns

Promise<Root[]>

log()

log(
   level, 
   message, 
   loggerName?): Promise<void>;
Defined in: server/context.ts:88 Send a log message to the client at the specified RFC 5424 severity level.

Parameters

level
LogLevel
message
string
loggerName?
string

Returns

Promise<void>

notice()

notice(message, loggerName?): Promise<void>;
Defined in: server/context.ts:91

Parameters

message
string
loggerName?
string

Returns

Promise<void>

onClose()

onClose(callback): void;
Defined in: server/context.ts:155 Register a callback that runs when the current session closes. Useful for releasing per-session resources (e.g. uploaded files). No-op if called outside an active HTTP session.

Parameters

callback
() => void

Returns

void

reportProgress()

reportProgress(
   progress, 
   total?, 
   message?): Promise<void>;
Defined in: server/context.ts:104 Send a progress notification to the client. No-op if the request did not include a progressToken in its _meta.

Parameters

progress
number
total?
number
message?
string

Returns

Promise<void>

resolveToolName()

resolveToolName(name): string;
Defined in: server/context.ts:146 Resolve a logical tool name to its current external name, accounting for any namespace prefix applied when the owning FastMCPApp was mounted. Returns the name unchanged when called outside a mounted context.

Parameters

name
string

Returns

string

sample()

sample(params): Promise<SamplingResult>;
Defined in: server/context.ts:112 Ask the client to perform an LLM inference call and return the result. Throws if the client has not advertised the sampling capability.

Parameters

params
SamplingParams

Returns

Promise<SamplingResult>

setState()

setState(key, value): void;
Defined in: server/context.ts:135 Store a value in session-scoped state. Persists for the lifetime of the session.

Parameters

key
string
value
unknown

Returns

void

warning()

warning(message, loggerName?): Promise<void>;
Defined in: server/context.ts:92

Parameters

message
string
loggerName?
string

Returns

Promise<void>