feat(plugin-mcp): add support for server instructions#15858
Merged
paulpopus merged 5 commits intopayloadcms:mainfrom Apr 16, 2026
Merged
feat(plugin-mcp): add support for server instructions#15858paulpopus merged 5 commits intopayloadcms:mainfrom
paulpopus merged 5 commits intopayloadcms:mainfrom
Conversation
Contributor
|
Cool! Makes sense to me! |
paulpopus
approved these changes
Apr 16, 2026
milamer
pushed a commit
to milamer/payload
that referenced
this pull request
Apr 20, 2026
### What?
Adds an `instructions` option to the MCP plugin's `MCPServerOptions`
type.
### Why?
The MCP protocol supports an `instructions` field that is sent to
clients during initialization. The Payload MCP plugin currently doesn't
expose this option, so users have no way to provide instructions
describing how to use the server and its features.
### How?
- Added `instructions` field to `MCPServerOptions` in `types.ts`
- Pass `instructions` through to the MCP SDK via `createMcpHandler` in
`getMcpHandler.ts`
```ts
mcpPlugin({
collections: { ... },
mcp: {
serverOptions: {
instructions: 'This server manages blog posts and pages.',
},
},
})
```
---------
Co-authored-by: Paul Popus <paul@payloadcms.com>
Contributor
|
🚀 This is included in version v3.84.0 |
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
3 participants
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.
What?
Adds an
instructionsoption to the MCP plugin'sMCPServerOptionstype.Why?
The MCP protocol supports an
instructionsfield that is sent to clients during initialization. The Payload MCP plugin currently doesn't expose this option, so users have no way to provide instructions describing how to use the server and its features.How?
instructionsfield toMCPServerOptionsintypes.tsinstructionsthrough to the MCP SDK viacreateMcpHandleringetMcpHandler.ts