Documentation / @agentick/mcp / MCPServer
Class: MCPServer
Defined in: server/server.ts:243
Constructors
Constructor
new MCPServer(
options):MCPServer
Defined in: server/server.ts:259
Parameters
options
Returns
MCPServer
Methods
close()
close():
Promise<void>
Defined in: server/server.ts:549
Returns
Promise<void>
connect()
connect(
transport):Promise<void>
Defined in: server/server.ts:281
Parameters
transport
Transport
Returns
Promise<void>
getActiveSessions()
getActiveSessions():
MCPSessionInfo[]
Defined in: server/server.ts:586
Returns
getRegisteredTools()
getRegisteredTools():
MCPToolDefinition[]
Defined in: server/server.ts:595
Returns
handleHTTPRequest()
handleHTTPRequest(
req,res):Promise<void>
Defined in: server/server.ts:326
Parameters
req
IncomingMessage
res
ServerResponse
Returns
Promise<void>
listRoots()
listRoots(
sessionId,opts?):Promise<Root[]>
Defined in: server/server.ts:666
Parameters
sessionId
string
opts?
force?
boolean
signal?
AbortSignal
timeoutMs?
number
Returns
Promise<Root[]>
off()
off<
E>(event,handler):void
Defined in: server/server.ts:499
Type Parameters
E
E extends keyof MCPServerEvents
Parameters
event
E
handler
(data) => void
Returns
void
on()
on<
E>(event,handler):void
Defined in: server/server.ts:495
Type Parameters
E
E extends keyof MCPServerEvents
Parameters
event
E
handler
(data) => void
Returns
void
registerApp()
registerApp(
definition):void
Defined in: server/server.ts:474
Parameters
definition
Returns
void
registerResource()
registerResource(
definition):void
Defined in: server/server.ts:449
Parameters
definition
MCPStaticResource | MCPResourceTemplateDefinition
Returns
void
registerTool()
registerTool(
definition):void
Defined in: server/server.ts:431
Parameters
definition
Returns
void
request()
request<
T>(sessionId,method,params,opts?):Promise<T>
Defined in: server/server.ts:620
Issue a request to the client connected at sessionId and await the response. The request is routed through the session's underlying SDK Server, so capability negotiation, transport, and serialization all use the same path the client established at initialize time.
Type Parameters
T
T = unknown
Parameters
sessionId
string
method
string
params
unknown
opts?
resultSchema?
ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
Zod schema for response validation. Defaults to passthrough (returns unknown).
signal?
AbortSignal
Abort signal — rejects with an abort error if signaled.
timeoutMs?
number
Hard timeout in milliseconds.
Returns
Promise<T>
Throws
if sessionId is not a known session
Throws
if the server has been closed
Throws
on timeout, abort, schema validation failure, or client error
requestElicitation()
requestElicitation(
sessionId,params,opts?):Promise<ElicitationResponse>
Defined in: server/server.ts:782
Parameters
sessionId
string
params
message
string
mode?
"form"
requestedSchema
opts?
signal?
AbortSignal
timeoutMs?
TimeoutOption
Returns
Promise<ElicitationResponse>
requestSampling()
requestSampling(
sessionId,params,opts?):Promise<SamplingResult>
Defined in: server/server.ts:746
Parameters
sessionId
string
params
opts?
signal?
AbortSignal
timeoutMs?
number
Returns
Promise<SamplingResult>
requestUrlElicitation()
requestUrlElicitation(
sessionId,params,opts?):Promise<UrlElicitationResponse>
Defined in: server/server.ts:809
Parameters
sessionId
string
params
elicitationId
string
message
string
mode
"url"
url
string
opts?
signal?
AbortSignal
timeoutMs?
TimeoutOption
Returns
Promise<UrlElicitationResponse>
unregisterApp()
unregisterApp(
uri):void
Defined in: server/server.ts:482
Parameters
uri
string
Returns
void
unregisterResource()
unregisterResource(
uriOrTemplate):void
Defined in: server/server.ts:464
Parameters
uriOrTemplate
string
Returns
void
unregisterTool()
unregisterTool(
name):void
Defined in: server/server.ts:440
Parameters
name
string
Returns
void