@posthog/mcp 0.0.8 → 0.1.16

package/LICENSE

@@ -1,6 +1,311 @@
+Copyright 2020 Posthog / Hiberly, Inc.
+
+Copyright 2015 Mixpanel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License below, or at:
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+---
+
+Some files in this codebase contain code from getsentry/sentry-javascript.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases.
+
 MIT License
 
-Copyright (c) 2025 MCPcat
+Copyright (c) 2012 Functional Software, Inc. dba Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Some files in this codebase contain code from getsentry/sentry-react-native.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases.
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Some files in this codebase contain code from facebook/metro by Meta Platforms, Inc. and affiliates.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases. 
+
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Some files in this codebase contain code from expo/expo by 650 Industries, Inc. (aka Expo).
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases. 
+
+The MIT License (MIT)
+
+Copyright (c) 2015-present 650 Industries, Inc. (aka Expo)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +323,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,146 +1,239 @@
-# PostHog MCP
+# @posthog/mcp
 
-TypeScript SDK for instrumenting Model Context Protocol servers with PostHog analytics.
+PostHog SDK for instrumenting [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) servers.
 
-> Warning:
-> This package is in very early access and is not suitable for production use yet.
-> The API, event names, PostHog property schema, tracing behavior, and release process may change without notice while we dogfood the SDK.
-> We publish in public because PostHog builds in public, but you should treat `0.0.x` releases as experimental.
-
-The initial goal is to help MCP server owners understand tool usage, agent intent, client/session metadata, errors, and feedback without hand-rolling MCP-specific analytics.
+One call wraps your MCP server and PostHog starts receiving structured events for every tool call, tool listing, initialize handshake, identify, and exception, with all the usual PostHog primitives (`$session_id`, `distinct_id`, `$set`, `$groups`, `$exception`) wired up automatically.
 
 ## Install
 
 ```bash
-pnpm add @posthog/mcp
+npm install @posthog/mcp posthog-node
 ```
 
-## Usage
+`@modelcontextprotocol/sdk` ≥ 1.26 and `posthog-node` ≥ 5 are peer dependencies.
 
-```ts
-import { Server } from "@modelcontextprotocol/sdk/server/index.js";
-import { track } from "@posthog/mcp";
+## Quick start
 
-const server = new Server({ name: "my-mcp-server", version: "1.0.0" });
+You bring your own [`posthog-node`](https://posthog.com/docs/libraries/node) client and pass it in (same pattern as [`@posthog/ai`](https://posthog.com/docs/libraries/ai)). You own its configuration and lifecycle — call `posthog.shutdown()` on exit so queued events flush.
 
-track(server, {
-  apiKey: process.env.POSTHOG_API_KEY,
-  context: true,
-  enableAITracing: true,
-  host: "https://us.i.posthog.com",
-});
+```ts
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
+import { PostHog } from 'posthog-node'
+import { z } from 'zod'
+import { instrument } from '@posthog/mcp'
+
+const posthog = new PostHog('phc_your_project_token', { host: 'https://us.i.posthog.com' })
+
+const server = new McpServer({ name: 'my-mcp-server', version: '1.0.0' })
+
+server.tool(
+  'search_docs',
+  'Search PostHog documentation',
+  { query: z.string() },
+  async ({ query }) => ({
+    content: [{ type: 'text', text: `Searching for "${query}"...` }],
+  })
+)
+
+// One line. From here on every tool call, tool listing, and initialize
+// handshake on this server is captured to PostHog.
+const analytics = instrument(server, posthog)
+
+// You own the client lifecycle — flush before the process exits.
+process.on('SIGTERM', async () => {
+  await posthog.shutdown()
+  process.exit(0)
+})
 ```
 
-With `context: true`, the SDK adds a required `context` argument to every tool call, strips it before invoking your handler, and captures it as `$mcp_intent` on PostHog events.
-Captured tool parameters omit the duplicated `context` value and MCP transport internals.
+What you get in PostHog out of the box:
+
+| Event | When | A few of the auto-captured properties |
+|---|---|---|
+| `$mcp_tool_call` | every tool invocation | `$mcp_tool_name`, `$mcp_parameters`, `$mcp_response`, `$mcp_duration_ms`, `$mcp_is_error` |
+| `$mcp_tools_list` | client lists tools | `$mcp_listed_tool_names` |
+| `$mcp_initialize` | client/server handshake | `$mcp_client_name`, `$mcp_client_version`, `$mcp_server_name` |
+| `$exception` | a tool throws or returns `isError` | `$exception_list`, `$exception_level` (standard PostHog error-tracking shape) |
+| `$identify` | first time `identify()` returns a non-null identity | `$set` populated from the identity's `properties` |
+| `$mcp_missing_capability` | agent calls `get_more_tools` (when `reportMissing` is on) | `$mcp_intent` — what the agent was looking for |
+
+Events for sessions with no resolved identity are sent with `$process_person_profile: false`, so anonymous MCP traffic doesn't mint a person profile per session.
+
+The full event + property catalog (including `$mcp_resources_*` / `$mcp_prompts_*`) lives in [`docs/ARCHITECTURE.md`](./docs/ARCHITECTURE.md).
+
+## Coming from another PostHog SDK?
+
+The surface maps onto concepts you already know — the main twist is that, because an MCP server handles many requests/sessions, the identity- and property-resolving hooks are **per-request callbacks** rather than imperative calls.
+
+| You know | Here it's | Note |
+|---|---|---|
+| BYO client in `@posthog/ai` | `instrument(server, posthog, options?)` → returns an `McpAnalytics` handle | Same pattern: you construct and own the `posthog-node` client and pass it positionally. |
+| `posthog.capture({ event, properties })` | `analytics.capture({ event, properties })` | A method on the handle returned by `instrument()`. `distinct_id` is derived from the session/identity for you. |
+| `posthog.identify({ distinctId, properties })` | `identify: (req) => ({ distinctId, properties, groups })` | A per-request callback. `properties` → `$set`, `groups` → `$groups`. |
+| `posthog.register(props)` (super properties) | `eventProperties: (req) => ({ … })` | Per-request instead of set-once; return constants for the "stamp on everything" case. |
+| `beforeSend` | `beforeSend(event)` | Identical contract to posthog-node. |
+
+## Common patterns
+
+### Identify the calling user
 
-Use `intentFallback` when you want a fallback for clients that call tools without the `context` argument.
-This is a consumer-supplied callback — the SDK does no inference of its own; whatever string you return becomes `$mcp_intent`.
-The explicit `context` argument always wins; fallback values are marked with `$mcp_intent_source = "inferred"`.
+`identify` runs on every tool call but only emits an `$identify` event when the returned identity actually changes for a session. From there on, events for that session are attributed to the user.
 
 ```ts
-track(server, {
-  apiKey: process.env.POSTHOG_API_KEY,
-  context: true,
-  intentFallback: (request) => {
-    const toolName = request.params?.name;
-    return toolName ? `Calling ${toolName}` : undefined;
+import jwt from 'jsonwebtoken'
+
+instrument(server, posthog, {
+  identify: async (request, extra) => {
+    const auth = extra?.headers?.authorization
+    if (!auth) return null
+
+    const { sub, email, plan } = jwt.verify(stripBearer(auth), SECRET) as {
+      sub: string
+      email: string
+      plan: 'free' | 'pro'
+    }
+
+    return {
+      distinctId: sub, // → distinct_id for the session
+      properties: { name: email, plan }, // → $set on the person
+      groups: { organization: 'org_123' }, // optional → $groups on every event
+    }
   },
-});
+})
 ```
 
-With `enableAITracing: true`, tool calls also emit `$ai_span` events with `$ai_trace_id` and `$ai_span_id`.
-The regular `mcp_tool_call` event includes the same trace/span IDs so it can be joined back to the LLM analytics span.
+This is the same shape as posthog-node's `identify({ distinctId, properties })`, just evaluated per request: `distinctId` becomes the `distinct_id`, `properties` are written to `$set` (so put `name`/`email`/etc there), and `groups` is stamped onto every event as `$groups` so you never hand-write the dollar-keyed properties yourself.
+
+### Capture user intent
 
-### Conversation ID (opt-in)
+PostHog injects an optional `context` parameter into every tool's input schema. When the LLM passes a value, the SDK stores it as `$mcp_intent` (with `$mcp_intent_source = "context_parameter"`) so dashboards can group tool calls by *why* the agent invoked them.
 
-When `enableConversationId: true` is passed to `track()`, the SDK injects an optional `conversation_id` argument into every tool's input schema and tells the agent to reuse the value the server returns. When the agent omits it on a call, the SDK mints a UUID and appends a short text block to the tool's response asking the agent to echo the same `conversation_id` on subsequent calls. The value the agent supplies (or the SDK mints) is captured on PostHog events as `$mcp_conversation_id` — separate from `$session_id`, which is unchanged. Off by default.
+If a client ignores the schema (raw cURL, in-house agents, JSON-blind crawlers), supply `intentFallback` and the SDK will derive an intent from the request:
 
 ```ts
-track(server, {
-  apiKey: process.env.POSTHOG_API_KEY,
-  enableConversationId: true,
-});
+instrument(server, posthog, {
+  intentFallback: (request) => {
+    const tool = request.params?.name
+    const args = request.params?.arguments ?? {}
+    if (tool === 'search_docs') return `Searching docs for "${args.query}"`
+    return tool ? `Invoking ${tool}` : null
+  },
+})
 ```
 
-**Caveats:**
+### Capture a custom event
+
+For domain-specific events that aren't auto-captured (e.g. user feedback, workflow milestones). Call `.capture()` on the handle returned by `instrument()`. You name the event; it's sent verbatim (it's your event, so it isn't `$`-prefixed):
+
+```ts
+const analytics = instrument(server, posthog)
+
+await analytics.capture({
+  event: 'feedback_submitted',
+  properties: { rating: 5, comment: 'love it' },
+})
+```
 
-- The prompt-back is appended as a regular `text` content block (the only channel MCP currently offers for server→agent communication). Consumers that surface raw tool-call content to end users will see `[SERVER]: Reuse conversation_id=…` in their UI. If/when the MCP spec grows a server-directives channel (e.g. on `_meta`), the SDK will move there.
-- The captured `$mcp_conversation_id` value is agent-controlled when the agent supplies one — the SDK accepts any non-empty string. Customers wanting to bind it to their own session scheme (chat ID, JWT `jti`, request ID) can do so freely; the trade-off is that nothing prevents a misbehaving agent from sending arbitrary values.
+The event is enriched with `$session_id`, `distinct_id`, and server/client metadata before being sent. `analytics.capture()` resolves once the event has been processed, so you can `await` it.
 
-The SDK sends events through `posthog-node`, so it uses the same PostHog ingestion client, batching, retry, flush, and shutdown behavior as the existing Node SDK.
+### Inspect, modify, or drop events before send (`beforeSend`)
 
-If your application already owns a PostHog client, pass it in instead:
+`beforeSend` runs on each fully-built payload right before it reaches `posthog.capture()` (same contract as posthog-node). Return the event to send it, mutate its `properties`, or return `null` to drop it. It runs once per emitted event, including the `$exception` sibling of a failed call.
 
 ```ts
-import { PostHog } from "posthog-node";
-import { track } from "@posthog/mcp";
+instrument(server, posthog, {
+  beforeSend: (event) => {
+    // Redact a property
+    if (typeof event.properties.$mcp_parameters === 'string') {
+      event.properties.$mcp_parameters = event.properties.$mcp_parameters.replace(/api_key_\w+/g, '[REDACTED]')
+    }
+    // Drop a whole class of events
+    if (event.event === '$exception') return null
+    return event
+  },
+})
+```
 
-const posthog = new PostHog(process.env.POSTHOG_API_KEY ?? "");
+### Attach extra properties to every event
 
-track(server, {
-  posthogClient: posthog,
-});
+```ts
+instrument(server, posthog, {
+  eventProperties: (request, extra) => ({
+    deployment: process.env.NODE_ENV,
+    region: 'us-east-1',
+    feature_flags: ['dark_mode', 'beta_ui'],
+  }),
+})
 ```
 
-## Event schema
+Returned keys are spread flat onto event properties, sitting alongside `$mcp_*` keys, and can intentionally override them.
 
-The SDK emits PostHog events using a stable MCP-specific schema.
-The package exports `PostHogMCPAnalyticsEvent`, `PostHogMCPAnalyticsProperty`, and `POSTHOG_MCP_ANALYTICS_SOURCE` constants so product code can query the same contract without hard-coded strings.
+### Get more tools (`reportMissing`)
 
-Canonical event names:
+Register an extra `get_more_tools` virtual tool that lets the agent report functionality it couldn't find. Each report lands as its own `$mcp_missing_capability` event (a capability gap, not a tool invocation) with the agent's reasoning in `$mcp_intent`.
 
-- `mcp_tool_call` for each MCP tool call
-- `mcp_tools_list` when clients list available tools
-- `mcp_initialize` when clients initialize a session
-- `$ai_span` for tool-call spans when `enableAITracing: true`
-- `$exception` for captured tool errors
+```ts
+instrument(server, posthog, {
+  reportMissing: true,
+})
+```
 
-Important properties:
+### Tie tool calls into a single conversation
 
-- `$mcp_source = "posthog_mcp_analytics"`
-- `$mcp_intent` from the `context` argument, or from `intentFallback` when no context was provided
-- `$mcp_intent_source` as `context_parameter` or `inferred`
-- `$mcp_tool_name` and `$mcp_resource_name`
-- `$mcp_tool_description`, the tool's current `description` at the moment of the call — populated on `mcp_tool_call` and on the paired `$exception` event so the description is visible inline while triaging
-- `$mcp_listed_tool_names`, the array of tool names advertised in a `tools/list` response — populated on `mcp_tools_list` events so you can correlate "tools the agent was offered" with "tools the agent actually called" (e.g. find advertised tools that never get picked)
-- `$mcp_parameters` and `$mcp_response`, after redaction and truncation
-- `$mcp_duration_ms`
-- `$mcp_is_error`
-- `$session_id`
-- `$ai_trace_id`, `$ai_span_id`, and `$ai_session_id` when AI tracing is enabled
+Opt into `enableConversationId: true` and the SDK injects a `conversation_id` parameter into every tool, mints one when the agent omits it, and appends a prompt-back text block telling the agent to echo it on every subsequent call. Events get `$mcp_conversation_id` so you can group all calls in an agent conversation.
 
-The SDK does not emit `$mcp_context`.
-Use `$mcp_intent` for agent/user intent.
+```ts
+instrument(server, posthog, {
+  enableConversationId: true,
+})
+```
 
-See [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md) for the full architecture, property catalog, sample queries, and migration notes vs the upstream mcpcat schema.
+### Turn off exception autocapture
 
-## Development
+A failed tool call emits an `$exception` sibling alongside the `$mcp_tool_call` by default. Set `enableExceptionAutocapture: false` if you track errors elsewhere and don't want MCP failures fanning into PostHog error tracking:
 
-```bash
-pnpm install
-pnpm verify
+```ts
+instrument(server, posthog, {
+  enableExceptionAutocapture: false,
+})
 ```
 
-Useful commands:
+## API
 
-```bash
-pnpm build
-pnpm test
-pnpm typecheck
-pnpm typecheck:tsc6
-pnpm fix
+- **`instrument(server, posthog, options?)`**: wraps a low-level `Server` or high-level `McpServer`. The `posthog-node` client is a required positional 2nd argument; `options` is optional. Idempotent per server instance (subsequent calls on the same server are skipped via a `WeakMap` lookup). Returns an `McpAnalytics` handle.
+- **`analytics.capture({ event, properties })`**: a method on the handle returned by `instrument()` that emits one custom event. `event` is required and sent verbatim (not `$`-prefixed). Returns a promise you can `await`.
+
+The full options reference lives in [`src/types.ts`](./src/types.ts) (`MCPAnalyticsOptions`) and the design narrative + HogQL recipes live in [`docs/ARCHITECTURE.md`](./docs/ARCHITECTURE.md).
+
+## Graceful shutdown
+
+The SDK doesn't own the client, so flushing is just `posthog.shutdown()` on your `posthog-node` instance — see the Quick start above. Nothing MCP-specific to tear down.
+
+### Serverless / short-lived processes
+
+In a serverless function (Lambda, Cloudflare Workers, Vercel) the process can freeze or exit before `posthog-node` flushes its queue. Flush explicitly at the end of the invocation rather than relying on a `SIGTERM` handler:
+
+```ts
+// at the end of the request/invocation
+await posthog.flush()
+// or keep the runtime alive until the flush completes
+ctx.waitUntil(posthog.flush())
 ```
 
-`pnpm typecheck` uses the TypeScript 7 native preview via `tsgo`.
+## Logging in STDIO MCP servers
 
-## Releases
+MCP over STDIO uses stdout/stderr for protocol messages, so the SDK never logs to them. Pass a `logger` callback if you want to capture SDK-internal warnings:
 
-Releases are semi-automatic through Changesets and GitHub Actions.
-See [RELEASE.md](./RELEASE.md) for the release process.
+```ts
+import fs from 'node:fs'
+const logStream = fs.createWriteStream('mcp.log', { flags: 'a' })
 
-Release approval requests are posted in Slack to `#approvals-client-libraries`.
+instrument(server, posthog, {
+  logger: (msg) => logStream.write(`${new Date().toISOString()} ${msg}\n`),
+})
+```
 
-## Attribution
+## Docs
 
-This SDK started from a duplicated copy of the MIT-licensed [MCPcat TypeScript SDK](https://github.com/MCPCat/mcpcat-typescript-sdk). We are grateful for their work on MCP server instrumentation patterns, especially tool-call tracing, context capture, and MCP SDK compatibility handling.
+- [`docs/ARCHITECTURE.md`](./docs/ARCHITECTURE.md): wire-up, request lifecycle, event pipeline, full event + property catalog, intent resolution, file map, HogQL query recipes.
+- [PostHog docs](https://posthog.com/docs): the rest.