Installing the MCP analytics SDK
Contents
@posthog/mcp is published as a 0.1.x alpha. Pin a specific version while we iterate — minor versions may include breaking changes to event shape or option names. A wizard-driven install (npx @posthog/wizard mcp-analytics add) is on the roadmap and will replace most of this page once it ships.
Requirements
- Node.js 18 or later (TypeScript/JavaScript), or Python 3.10+ — see Python below
- An MCP server built on
@modelcontextprotocol/sdk(TS) or themcppackage (Python). (Running a custom dispatcher with no server object to wrap? See Custom servers.) - A PostHog project API key (
phc_…)
Install
You bring your own posthog-node client (the same pattern as @posthog/ai) and pass it to instrument() as the required second argument. You own its lifecycle — call posthog.shutdown() or posthog.flush() yourself.
Wrap your server
instrument(server, posthog, options?) is the only function you need to call. The posthog client is a required positional argument; options is optional. It returns an analytics handle (used for custom events). It's idempotent per server — calling it twice on the same server logs a warning and returns early.
Low-level Server
If you registered your tools against the raw protocol Server from @modelcontextprotocol/sdk/server/index.js:
High-level McpServer
If you use the typed McpServer wrapper from @modelcontextprotocol/sdk/server/mcp.js, pass it in directly — the SDK will unwrap it and also install a proxy on _registeredTools, so any tool you register after instrument() is also wrapped:
Python
A Python SDK ships inside the posthog package (the same way posthog.ai does). Install it with the mcp extra:
instrument(server, posthog_client, options?) works with every common Python MCP server:
FastMCPand the low-levelServerfrom the officialmodelcontextprotocol/python-sdk(themcppackage)- jlowin's standalone FastMCP 2.0 (the separate
fastmcppackage) PostHogMCPfor custom dispatchers with no server object (see below)
Options are passed as MCPAnalyticsOptions, the snake_case equivalent of the TypeScript options:
MCPAnalyticsOptions fields (the TypeScript Configuration table below uses camelCase — these are the Python names):
| Option | Type | Default | What it does |
|---|---|---|---|
context | bool \| MCPAnalyticsContextOptions | True | Inject the context intent argument into every tool. |
report_missing | bool | False | Register the get_more_tools virtual tool. |
missing_capability_tool_name | str | "get_more_tools" | Rename the virtual tool registered by report_missing. |
enable_conversation_id | bool | False | Inject an optional conversation_id argument to stitch calls. |
enable_exception_autocapture | bool | True | Emit a $exception sibling on failed tool calls. |
identify | (request, extra) -> UserIdentity \| None (sync or async) | — | Map a request to one of your users. |
intent_fallback | (request, extra) -> str \| None | — | Provide intent when the agent didn't pass context. |
before_send | (event) -> event \| None | — | Inspect/modify/drop each event before send. |
event_properties | (request, extra) -> dict | — | Properties merged onto every event. |
logger | (message: str) -> None | no-op | STDIO-safe log sink. |
Flushing on exit
The posthog client batches events asynchronously and you own its lifecycle. On the instrument() path, auto-captured events are scheduled in the background — await analytics.flush() waits for in-flight events, then posthog.flush() / posthog.shutdown() sends them. Call this from your shutdown/SIGTERM handler so trailing events aren't dropped (see examples/mcp_analytics_demo.py for a runnable end-to-end example):
No server object to wrap (a custom HTTP/edge dispatcher)? Use PostHogMCP, a posthog client subclass with capture_tool_call(), capture_initialize(), prepare_tool_list(), and prepare_tool_call() — the Python equivalent of Custom servers.
The Python SDK is alpha and TypeScript-only features may land first. It emits the identical $mcp_* events documented on the events page.
Configuration
The posthog client is passed as the required second positional argument — not in this options object. instrument() accepts these options as an optional third argument:
| Option | Type | Default | What it does |
|---|---|---|---|
logger | (message: string) => void | no-op | STDIO-safe log sink for SDK-internal warnings. MCP STDIO transports cannot use console.*, so the default discards. Wire your own to surface warnings during development. |
enableExceptionAutocapture | boolean | true | When false, a failed tool call does not emit the $exception sibling event. |
context | boolean \| { description: string } | true | Inject a required context argument into every tool schema. See Capturing agent intent. |
intentFallback | (request, extra) => string \| Promise<string \| null \| undefined> | — | Called when the agent didn't pass a context argument. See Capturing agent intent. |
enableConversationId | boolean | false | Inject an optional conversation_id argument into every tool. See Conversation IDs. |
reportMissing | boolean | false | Register the get_more_tools virtual tool. See Missing capability. |
identify | async (request, extra) => UserIdentity \| null \| UserIdentity | — | Map an MCP request to one of your users. See Identifying users. |
beforeSend | (event) => event \| null \| undefined \| Promise<...> | — | Runs on each fully-built PostHog payload right before send. Return the (possibly mutated) event to send it, or a nullish value to drop it. See Privacy. |
eventProperties | async (request, extra) => Record<string, unknown> | — | Properties merged onto every event. See Custom events and metadata. |
Graceful shutdown
The posthog-node client queues and batches events asynchronously, and you own its lifecycle. Call posthog.shutdown() from your SIGTERM / beforeExit handler so in-flight events aren't dropped:
If you only want to drain the queue without tearing the client down, call posthog.flush() instead.
In serverless or edge environments where SIGTERM isn't reliable, flush explicitly at the end of each invocation — await posthog.flush(), or ctx.waitUntil(posthog.flush()) on platforms that support it — rather than relying on a shutdown signal.
What happens after install
As soon as the wrapper is in place, every MCP request handled by the server emits a PostHog event:
$mcp_tool_callper tool invocation$mcp_tools_listpertools/listresponse$mcp_initializeper client handshake$mcp_resource_read,$mcp_resources_list,$mcp_prompt_get,$mcp_prompts_listas applicable$exceptionwhenever a tool throws or returnsisError: true
All events share a $session_id derived from the MCP protocol session (so the same connection always maps to the same PostHog session). See the event reference for the full catalog.