docs(plugin-mcp): recommend HTTP and explain stdio limitations#17374
Merged
Conversation
AlessioGr
enabled auto-merge (squash)
July 17, 2026 06:03
Contributor
📦 esbuild Bundle Analysis for payloadThis analysis was generated by esbuild-bundle-analyzer. 🤖
Largest pathsThese visualization shows top 20 largest paths in the bundle.Meta file: packages/next/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_shared.json, Out file: esbuild/exports/shared.js
Meta file: packages/richtext-lexical/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_shared.json, Out file: esbuild/exports/shared_optimized/index.js
DetailsNext to the size is how much the size has increased or decreased compared with the base branch of this PR.
|
paulpopus
previously approved these changes
Jul 17, 2026
paulpopus
approved these changes
Jul 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the MCP documentation to recommend HTTP for both local development and production. The docs now mainly recommend the use HTTP. The stdio instructions are kept in one section at the end of the page, together with its current limitations.
It also makes the stdio CLI load
.envfiles before importing the payload config. This matches the normal Payload CLI and allows config values such asPAYLOAD_SECRETto work without adding them separately to the MCP client configuration.Why?
Stdio is convenient during development because it is simple to configure, can work well in repos with multiple payload configs (like our monorepo), and avoids MCP client connection timeouts or race conditions.
The main drawback is HMR. The stdio process loads the Payload config and MCP registrations once, so changes such as adding a collection or tool normally require a restart. Given stdio would usually be used during development, where these things usually happen, we cannot recommend it in this state. HTTP does not have this problem because it uses the running app’s existing HMR (e.g. Next.js HMR through getPayload).
I attempted to add HMR to the stdio mcp process by using Vite as an optional peer dependency, since Next.js is not available to handle HMR for this standalone process. The reload worked, but keeping the long-running MCP server and its authorization state in sync added too much complexity to the plugin. The attempted fix is preserved on
fix/do-not-delete-branch-stdio-hmrif we revisit it. For now, this is not high priority. The stdio mcp remains usable in its current state