Interface ServerInstance

ReadonlyisRunning

Readonlyname

Readonlyversion

initTelemetry

• initTelemetry(): Promise<void>

  Initialize OpenTelemetry before starting the server.

  OTEL auto-instrumentation must be initialized before any HTTP/Express modules are loaded to properly instrument them. Call this method as early as possible in your application bootstrap.

  If not called explicitly, start() will initialize telemetry automatically as a fallback (but auto-instrumentation may miss modules already loaded).

  No-op if telemetry is not enabled in server options.

  Returns Promise<void>

  Example

  const server = builder.build();
  await server.initTelemetry(); // Before any other imports
  await server.start();
  Copy

notifyPromptListChanged

• notifyPromptListChanged(): void

  Notify all connected MCP clients that the prompt list has changed.

  Call this when prompt availability changes dynamically. The framework will send notifications/prompts/list_changed to all connected clients per MCP specification.

  Returns void

notifyResourceListChanged

• notifyResourceListChanged(): void

  Notify all connected MCP clients that the resource list has changed.

  Call this when resource availability changes dynamically. The framework will send notifications/resources/list_changed to all connected clients per MCP specification.

  Returns void

notifyResourceUpdated

• notifyResourceUpdated(uri: string): void

  Notify subscribed MCP clients that a specific resource has been updated.

  Only clients that previously sent resources/subscribe for the given URI receive the notifications/resources/updated notification.

  Requires capabilities: { resources: { subscribe: true } } to be set.

  Parameters

  • uri: string

    The resource URI that has changed

  Returns void

  Example

  // When a monitored resource changes
  server.notifyResourceUpdated('config://app/settings');
  Copy

notifyToolListChanged

• notifyToolListChanged(): void

  Notify all connected MCP clients that the tool list has changed.

  Call this when tool availability changes (e.g., connection state). The framework will send notifications/tools/list_changed to all connected clients per MCP specification.

  Returns void

  Example

  // When API connection established
  apiClient.on('connected', () => server.notifyToolListChanged());
  
  // When API connection lost
  apiClient.on('disconnected', () => server.notifyToolListChanged());
  Copy

start

• start(): Promise<void>

  Start the server

  Returns Promise<void>

stop

• stop(): Promise<void>

  Stop the server gracefully

  Returns Promise<void>