Skip to content

Better MCP docs#16975

Merged
joethreepwood merged 6 commits into
masterfrom
mcp-docs
May 27, 2026
Merged

Better MCP docs#16975
joethreepwood merged 6 commits into
masterfrom
mcp-docs

Conversation

@joethreepwood
Copy link
Copy Markdown
Contributor

Changes

A better page with this, I think.

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

Copy link
Copy Markdown
Contributor

@joshsny joshsny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great, much better than it was - wonder if we should talk about the plugins at all, since we're leaning heavily into skills we actually want folks to use the plugins (which bundle the MCP server and skills together) when one is available for their client, thoughts?

Comment thread contents/docs/model-context-protocol/index.mdx Outdated

### Which AI clients and editors are supported?

Anything that speaks MCP works. We've tested and documented setup for Claude Code, Claude Desktop, Cursor, Codex, VS Code, Windsurf, and Zed. The [PostHog Wizard](https://github.com/PostHog/wizard) can install the server into most of these in one command.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of scope of the PR, but we should be installing into all those clients, if not we should make sure that it does that

@skoob13
Copy link
Copy Markdown
Contributor

skoob13 commented May 22, 2026

Looks great! I wanted to add the same comment that Josh had regarding plugins. They ship skills and sometimes misc hooks and scripts, gluing the experience together, so we always need to highlight that it is the recommended experience. The demo is awesome!

Copy link
Copy Markdown
Member

@edwinyjlim edwinyjlim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so much cleaner

my main feedback is that it's still a very long scroll. I'd break these out into multiple pages

I think we should could keep one or two example prompt sections on the overview page and move the rest to a dedicated page. my gut is that developers like seeing the massive table of MCP tools, but you could make that its own page too

Overview (current page at /docs/model-context-protocol)
Use cases (/docs/model-context-protocol/use-cases)
FAQ (/docs/model-context-protocol/FAQ)
Image

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview May 27, 2026 10:05AM

@github-actions
Copy link
Copy Markdown
Contributor

Vale prose linter → found 5 errors, 41 warnings, 0 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/model-context-protocol/_snippets/shared.mdx — 0 errors, 2 warnings, 0 suggestions
Line Severity Message Rule
1:71 warning 'untrusted' is a possible misspelling. PostHogBase.Spelling
5:128 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
contents/docs/model-context-protocol/faq.mdx — 5 errors, 18 warnings, 0 suggestions
Line Severity Message Rule
10:71 warning 'untrusted' is a possible misspelling. PostHogBase.Spelling
16:150 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
16:165 warning Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. PostHogBase.ProductNames
16:184 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
16:200 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
16:231 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
28:5 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
28:108 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
36:69 warning 'untrusted' is a possible misspelling. PostHogBase.Spelling
40:5 warning 'Using an API key instead of OAuth' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
40:33 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
42:36 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
73: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
74:25 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
78:20 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
79:15 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
100:57 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
123:31 warning Capitalize 'Data Warehouse' for PostHog's product. Use 'Data warehouse' for the general industry concept. PostHogBase.ProductNames
129:43 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
158:68 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
189:24 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
190:26 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
191:17 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
contents/docs/model-context-protocol/index.mdx — 0 errors, 3 warnings, 0 suggestions
Line Severity Message Rule
40:91 warning 'triaging' is a possible misspelling. PostHogBase.Spelling
61:128 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
72:95 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
contents/docs/model-context-protocol/tools.mdx — 0 errors, 5 warnings, 0 suggestions
Line Severity Message Rule
10:91 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
10:109 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
10:124 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
10:140 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
10:146 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
contents/docs/model-context-protocol/use-cases.mdx — 0 errors, 13 warnings, 0 suggestions
Line Severity Message Rule
16:92 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
16:158 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
35:5 warning 'Explore product analytics' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
35:13 warning Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. PostHogBase.ProductNames
52:12 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
52:30 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
54:49 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
54:97 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
54:161 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
73:5 warning 'Run SQL and HogQL queries' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
90:32 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
130:109 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
157:32 warning Capitalize 'Experimentation' for PostHog's product. Use 'experimentation' for the general industry concept. PostHogBase.ProductNames

@joethreepwood
Copy link
Copy Markdown
Contributor Author

Nice. I've split this off into multiple pages, and auto-merging given the ✅ s from you all.

The other change from Josh and Georgiy seems a little out of scope for this.

@joethreepwood joethreepwood enabled auto-merge (squash) May 27, 2026 09:58
@joethreepwood joethreepwood merged commit 340bb61 into master May 27, 2026
17 checks passed
@joethreepwood joethreepwood deleted the mcp-docs branch May 27, 2026 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants