Skip to content

docs(mcp-analytics): document resource events and URL credential redaction - #20078

Merged
lucasheriques merged 2 commits into
masterfrom
lucas/mcp-analytics-resource-docs
Sep 10, 2026
Merged

lucasheriques merged 2 commits into
masterfrom
lucas/mcp-analytics-resource-docs

Conversation

@lucasheriques

@lucasheriques lucasheriques commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Changes

The MCP Analytics SDKs now emit resource events and redact credentials inside every captured URL (PostHog/posthog-js#4830, PostHog/posthog-python#928). This brings the docs in line:

  • Event and property reference: adds $mcp_resources_list (resources/list and resources/templates/list, carrying the listing as $mcp_response) and $mcp_resource_read (URI, timing, error state, never the body); drops the "not emitted yet" note for resources (prompts keep it); rewords $mcp_resource_name, $mcp_response, $mcp_duration_ms, $mcp_is_error and the $exception row to cover resource requests.
  • Privacy and redaction: resource bodies are listed under what never leaves the process, and the sanitizer list gains the URL credential rule (userinfo, credential-named query and fragment fields matched per segment, nested URLs, authority-less URIs, the over-redaction trade, and the 8 KB / 128-field bounds).
  • SDK v2: removes the resource gap from the "not instrumented yet" table and the MCP Apps paragraph.
  • Start here: the one-line sanitization summary mentions credentials inside URLs.

Ships with @posthog/mcp 0.15.0 and posthog 7.51.0, both published; the events page names those as the minimum versions.

Checklist

  • I've read the docs and/or content style guides.
  • Words are spelled using American English
  • Use relative URLs for internal links
  • I've checked the pages added or changed in the Vercel preview build
  • If I moved a page, I added a redirect in vercel.json (no pages moved)

https://claude.ai/code/session_01VGVQTsHUk5dmQC2rGPEgc7

…ction

The SDKs now emit $mcp_resources_list (resources/list and
resources/templates/list, carrying the listing) and $mcp_resource_read
(URI, timing, error state, never the body), and redact credentials inside
every captured URL. The events reference gains both rows and drops the
"not emitted yet" note; the privacy page states that resource bodies never
leave the process and describes the URL rule; the SDK v2 page drops the
resource gap from its "not instrumented yet" table.

Shipped in PostHog/posthog-js#4830 and PostHog/posthog-python#928.

Claude-Session: https://claude.ai/code/session_01VGVQTsHUk5dmQC2rGPEgc7
@github-actions github-actions Bot added docs Improvements or additions to product documentation, "Docs" content PR only touches files under contents/ labels Sep 10, 2026
@github-actions

github-actions Bot commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Sep 10, 2026 06:38PM

Changed pages

Page Source
Event and property reference contents/docs/mcp-analytics/events.mdx
Privacy and redaction contents/docs/mcp-analytics/privacy.mdx
MCP SDK v2 contents/docs/mcp-analytics/sdk-v2.mdx
Getting started with MCP Analytics contents/docs/mcp-analytics/start-here.mdx

@github-actions

github-actions Bot commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Vale prose linter → found 33 errors, 22 warnings, 2 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/mcp-analytics/events.mdx — 14 errors, 13 warnings, 1 suggestions
Line Severity Message Rule
31:84 warning Use 'ID' instead of 'id'. Vale.Terms
31:178 warning Use 'ID' instead of 'id'. Vale.Terms
31:265 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
31:276 warning Use 'ID' instead of 'id'. Vale.Terms
46:157 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
47:173 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
48:270 warning 'accessors' is a possible misspelling. PostHogBase.Spelling
48:280 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
59:17 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
61:29 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
61:141 warning Use 'AI' instead of 'ai'. Vale.Terms
61:145 warning 'Cowork' is a possible misspelling. PostHogBase.Spelling
62:33 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
63:27 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
65:157 warning Use 'AI' instead of 'ai'. Vale.Terms
65:191 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
65:388 warning Use 'AI' instead of 'ai'. Vale.Terms
67:191 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
71:209 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
71:236 warning Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. PostHogBase.ProductNames
82:49 warning 'symbolicate' is a possible misspelling. PostHogBase.Spelling
82:107 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
98:73 warning 'groupType' is a possible misspelling. PostHogBase.Spelling
98:85 warning 'groupKey' is a possible misspelling. PostHogBase.Spelling
108:34 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
109:30 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
110:33 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
112:57 warning 'typesafe' is a possible misspelling. PostHogBase.Spelling
contents/docs/mcp-analytics/privacy.mdx — 11 errors, 3 warnings, 0 suggestions
Line Severity Message Rule
7:45 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
37:47 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
40:32 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
42:140 warning Avoid trivializing words. 'obviously' can sound dismissive to the reader. PostHogDocs.Trivializers
42:235 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
56:55 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
75:185 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
89:163 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
101:140 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
107:37 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
109:125 warning 'kwarg' is a possible misspelling. PostHogBase.Spelling
126:41 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
146:158 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
154:140 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
contents/docs/mcp-analytics/sdk-v2.mdx — 8 errors, 6 warnings, 0 suggestions
Line Severity Message Rule
7:112 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
40:11 warning Use 'X' instead of 'x'. Vale.Terms
42:191 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
61:151 warning Use 'X' instead of 'x'. Vale.Terms
61:227 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
76:46 warning 'jlowin's' is a possible misspelling. PostHogBase.Spelling
76:119 warning Use 'X' instead of 'x'. Vale.Terms
88:99 warning Use 'ID' instead of 'id'. Vale.Terms
92:202 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
94:75 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
95:59 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
101:172 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
111:4 warning 'MCP Apps' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
125:36 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
contents/docs/mcp-analytics/start-here.mdx — 0 errors, 0 warnings, 1 suggestions
Line Severity Message Rule
122:63 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress

@github-actions

github-actions Bot commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

8.86 MiB (+0.3 KiB / +0.0%)

Eager graph (modules shipped in each entrypoint's initial chunks)

Entrypoint Eager size Budget Modules
✅ app 18.48 MiB (+3.0 KiB / +0.0%) report-only 2054
Largest modules in the app closure
Module Size
./src/data/mcp-tools.json 1123.5 KiB
css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css 761.5 KiB
./src/components/Stickers/Stickers.tsx 696.4 KiB
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js 481.4 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/x-ray.mjs 480.8 KiB
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules 395.1 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/im-the-driver.mjs 385.7 KiB
./src/hooks/useCustomers.tsx + 55 modules 370.0 KiB
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js 354.8 KiB
./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules 351.4 KiB
./src/components/ProductComparisonTable/index.tsx + 126 modules 305.7 KiB
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js 281.9 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/doll-house.mjs 281.7 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/director.mjs 275.6 KiB
./src/components/SearchUI/index.tsx + 87 modules 273.7 KiB

Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes for the modules actually shipped in the entrypoint's initial chunks (post-tree-shake).

@lucasheriques
lucasheriques marked this pull request as ready for review September 10, 2026 18:40
@lucasheriques
lucasheriques merged commit 9649fd1 into master Sep 10, 2026
21 of 22 checks passed
@lucasheriques
lucasheriques deleted the lucas/mcp-analytics-resource-docs branch September 10, 2026 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content PR only touches files under contents/ docs Improvements or additions to product documentation, "Docs"

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant