Documentation / @agentick/gateway / PluginContext
Interface: PluginContext
Defined in: gateway/src/types.ts:197
Properties
config
config:
ConfigStore
Defined in: gateway/src/types.ts:254
Gateway configuration store
gatewayId
gatewayId:
string
Defined in: gateway/src/types.ts:257
Gateway ID for logging
Methods
broadcast()
broadcast(
event,data):void
Defined in: gateway/src/types.ts:227
Broadcast an event to all clients subscribed to this plugin
Parameters
event
string
data
unknown
Returns
void
invoke()
invoke(
method,params):Promise<unknown>
Defined in: gateway/src/types.ts:218
Invoke any gateway method (including other plugins')
Parameters
method
string
params
unknown
Returns
Promise<unknown>
listPlugins()
listPlugins():
object[]
Defined in: gateway/src/types.ts:251
List all registered plugins with their methods
Returns
object[]
off()
off<
K>(event,handler):void
Defined in: gateway/src/types.ts:224
Unsubscribe from gateway events
Type Parameters
K
K extends keyof GatewayEvents
Parameters
event
K
handler
(payload) => void
Returns
void
on()
on<
K>(event,handler):void
Defined in: gateway/src/types.ts:221
Subscribe to gateway lifecycle events
Type Parameters
K
K extends keyof GatewayEvents
Parameters
event
K
handler
(payload) => void
Returns
void
registerMethod()
registerMethod(
path,handler):void
Defined in: gateway/src/types.ts:212
Register a callable method (for outbound capabilities)
Parameters
path
string
handler
SimpleMethodHandler<Record<string, unknown>, unknown> | MethodDefinition<ZodLikeSchema>
Returns
void
registerRoute()
registerRoute(
path,handler,options?):void
Defined in: gateway/src/types.ts:234
Mount an HTTP route handler on the gateway's HTTP server. Path is relative to the gateway's httpPathPrefix by default (e.g., "mcp" → "{prefix}/mcp"). Pass { absolute: true } for paths that must be at the domain root regardless of prefix (e.g., /.well-known/oauth-authorization-server). Routes enforce gateway auth by default. Pass { auth: false } to skip.
Parameters
path
string
handler
(req, res) => void | Promise<void>
options?
absolute?
boolean
auth?
boolean
Returns
void
respondToConfirmation()
respondToConfirmation(
sessionKey,callId,response):Promise<void>
Defined in: gateway/src/types.ts:205
Respond to a tool confirmation request within a session
Parameters
sessionKey
string
callId
string
response
Returns
Promise<void>
sendToSession()
sendToSession(
sessionKey,input):Promise<AsyncIterable<StreamEvent,any,any>>
Defined in: gateway/src/types.ts:202
Route inbound messages to a session (creates if needed). Returns the execution's event stream — iterate to observe responses, tool confirmations, etc. The gateway also broadcasts events to transport subscribers independently, so ignoring the return is safe.
Parameters
sessionKey
string
input
Returns
Promise<AsyncIterable<StreamEvent, any, any>>
unregisterMethod()
unregisterMethod(
path):void
Defined in: gateway/src/types.ts:215
Unregister a method this plugin registered
Parameters
path
string
Returns
void
unregisterRoute()
unregisterRoute(
path):void
Defined in: gateway/src/types.ts:244
Unmount a route this plugin registered
Parameters
path
string
Returns
void
validateAuth()
validateAuth(
token):Promise<AuthResult>
Defined in: gateway/src/types.ts:248
Validate an auth token against the gateway's auth config. Plugins can use this to enforce auth on their custom routes.
Parameters
token
string | undefined
Returns
Promise<AuthResult>