Interface: StartServerOptions<TContext> ​

Defined in: packages/core/src/server/startServer.ts:34

Options for startServer.

Type Parameters ​

Type Parameter
TContext

Properties ​

attach? ​

ts
readonly optional attach: Omit<AttachOptions<TContext>, "contextFactory" | "prompts" | "telemetry">;

Defined in: packages/core/src/server/startServer.ts:68

Extra attach options (debug, tracing, zeroTrust, etc.).

contextFactory()? ​

ts
readonly optional contextFactory: (extra) => TContext | Promise<TContext>;

Defined in: packages/core/src/server/startServer.ts:48

Factory to create per-request context.

Parameters ​

ParameterType
extraunknown

Returns ​

TContext | Promise<TContext>

name ​

ts
readonly name: string;

Defined in: packages/core/src/server/startServer.ts:36

Server display name (shown in MCP clients and Inspector).

port? ​

ts
readonly optional port: number;

Defined in: packages/core/src/server/startServer.ts:65

Port for the HTTP server (only used when transport: 'http').

Default ​

ts
3001

prompts? ​

ts
readonly optional prompts: PromptRegistry<TContext>;

Defined in: packages/core/src/server/startServer.ts:45

Optional prompt registry.

registry ​

ts
readonly registry: ServerRegistry<TContext>;

Defined in: packages/core/src/server/startServer.ts:42

The tool registry to expose.

telemetry? ​

ts
readonly optional telemetry: boolean;

Defined in: packages/core/src/server/startServer.ts:51

Enable Inspector TUI telemetry (default: true).

transport? ​

ts
readonly optional transport: ServerTransport;

Defined in: packages/core/src/server/startServer.ts:59

Transport layer: 'stdio' (default) or 'http' (Streamable HTTP).

  • stdio — connects via stdin/stdout (for Cursor, Claude Desktop)
  • http — starts an HTTP server with session management on /mcp

version? ​

ts
readonly optional version: string;

Defined in: packages/core/src/server/startServer.ts:39

Server version string (e.g. '1.0.0').