Skip to main content

Function: startSignozMcpServer()

startSignozMcpServer(options): Promise<RunningSignozMcpServer>

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

Build the SigNoz MCP server and serve it over Streamable HTTP at http://127.0.0.1:<port>/mcp.

Stateless: every POST gets a fresh server and transport, so there is no session to leak or expire; the SDK client (and its session rotation) is shared across them. Requests whose Host is not loopback are refused (DNS rebinding), GET /health answers { ok, baseUrl, auth, version } and, with a shutdownToken, POST /shutdown stops it. Resolves once the port is bound; rejects if it cannot be (e.g. in use).

import { startSignozMcpServer } from "@hoyasumii/signoz/mcp";
const mcp = await startSignozMcpServer({ port: 3767, baseUrl: "https://signoz.example.com", apiKey: "…" });
// claude mcp add --transport http signoz http://127.0.0.1:3767/mcp

Parameters​

options​

SignozMcpServerOptions

Returns​

Promise<RunningSignozMcpServer>