Skip to main content

Interface: SignozMcpServerOptions

Defined in: src/mcp/server.ts:8

The connection a transport needs: the SigNoz URL and one credential.

Extends​

Properties​

apiKey?​

optional apiKey?: string

Defined in: src/mcp/config.ts:201

Inherited from​

SignozConnection.apiKey

authToken?​

optional authToken?: string

Defined in: src/mcp/config.ts:202

Inherited from​

SignozConnection.authToken

baseUrl​

baseUrl: string

Defined in: src/mcp/config.ts:200

Inherited from​

SignozConnection.baseUrl

environment?​

optional environment?: string

Defined in: src/mcp/server.ts:12

The default deployment.environment the telemetry tools filter on.

onShutdown?​

optional onShutdown?: () => void

Defined in: src/mcp/server.ts:20

Called after /shutdown has closed the server — the process exits there.

Returns​

void

port​

port: number

Defined in: src/mcp/server.ts:10

Port to listen on, on 127.0.0.1. 0 picks a free one; read it back from url.

refreshAuthToken?​

optional refreshAuthToken?: string

Defined in: src/mcp/config.ts:203

Inherited from​

SignozConnection.refreshAuthToken

sessionFile?​

optional sessionFile?: string

Defined in: src/mcp/config.ts:208

Where rotated session tokens persist, so every process started from the same config shares them. Ignored with an API key. Default: none (the pair lives in memory only).

Inherited from​

SignozConnection.sessionFile

shutdownToken?​

optional shutdownToken?: string

Defined in: src/mcp/server.ts:18

Enables POST /shutdown: a request carrying this value in X-Signoz-Shutdown closes the server (202); any other value gets 403. signoz mcp stop uses it, because on Windows a signal is TerminateProcess and no cleanup would run.