Class MCPServer

constructor

• new MCPServer(opts: MCPServerOptions): MCPServer

  Parameters

  • opts: MCPServerOptions

  Returns MCPServer

Readonlyconfig

Readonlyname

Readonlyprompts

Readonlyregistry

Readonlyresources

Optional ReadonlysessionId

Readonlytools

Readonlyversion

Readonlyviewer

attach

• attach(sink: OutgoingMessageSink): void

  Attach an outgoing-message sink. Required before handling messages.

  Parameters

  • sink: OutgoingMessageSink

  Returns void

detach

• detach(): void

  Returns void

handleMessage

• handleMessage(message: JsonRpcMessage): Promise<JsonRpcResponse | null>

  Process a single inbound JSON-RPC message. Returns the response (if any) or null for notifications. Side-effect notifications (progress, log) flow through the attached sink, not the return value.

  Parameters

  • message: JsonRpcMessage

  Returns Promise<JsonRpcResponse | null>

hasModelAccess

• hasModelAccess(modelId: string): boolean

  Read-only access to the auth scope for transports that need to gate access.

  Parameters

  • modelId: string

  Returns boolean

isInitialized

• isInitialized(): boolean

  Returns boolean

maybeAutoOpenViewer

• maybeAutoOpenViewer(
      overrides?: { autoOpen?: boolean; port?: number },
  ): Promise<ViewerState | null>

  Open the in-process viewer for the first loaded model if configured to do so, otherwise a no-op. Makes ServerConfig.autoOpenViewer / .viewerPort (issue #2731 finding 4) actually take effect for any caller that constructs MCPServer with config, not just the CLI.

  Precedence: overrides (an explicit, per-call instruction — this is what a CLI flag like --viewer represents) beats this.config (set at construction, e.g. by an embedder) beats the built-in default of "do not auto-open, port 0". A field left undefined at one level falls through to the next.

  No-ops (returns null) when auto-open resolves to false/undefined, or when no model is loaded yet. Errors from ViewerManager.open() propagate — callers that already have their own logging/fallback (the CLI does) can catch and report; callers that don't want that risk can check registry.count() first.

  Parameters

  • Optionaloverrides: { autoOpen?: boolean; port?: number }

  Returns Promise<ViewerState | null>

notifyResourceUpdated

• notifyResourceUpdated(uri: string): void

  Broadcast a notifications/resources/updated to subscribers.

  Parameters

  • uri: string

  Returns void

notifyToolsChanged

• notifyToolsChanged(): void

  Notify clients that the tool list has changed (e.g., after model load).

  Returns void

setScope

• setScope(scope: AuthScope): void

  Update the auth scope mid-session (e.g. token refresh).

  Parameters

  • scope: AuthScope

  Returns void