feat(plugin-mcp): adds custom auth config #14538
Merged
Conversation
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
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.
|
DanRibbens
requested changes
Nov 10, 2025
Contributor
DanRibbens
left a comment
DanRibbens
left a comment
There was a problem hiding this comment.
Coulpe considerations
| err: error, | ||
| msg: '[payload-mcp] Custom authentication method failed', | ||
| }) | ||
| throw new APIError('Authentication failed', 401) |
Contributor
There was a problem hiding this comment.
I think you want to import UnauthorizedError to throw a translated error message instead of this hard coded one.
Contributor
Author
There was a problem hiding this comment.
I used AuthenticationError
| : null | ||
|
|
||
| if (apiKey === null) { | ||
| throw new APIError('API Key is required', 401) |
Contributor
There was a problem hiding this comment.
Again, we need to reuse existing errors whenever possible to get translations.
Contributor
Author
There was a problem hiding this comment.
I used AuthenticationError here as well
DanRibbens
reviewed
Nov 11, 2025
| }) | ||
|
|
||
| if (docs.length === 0) { | ||
| throw new AuthenticationError() |
Contributor
There was a problem hiding this comment.
This is going to give the message: 'The email or password provided is incorrect.' though, I don't think that is right as we're dealing with API keys, right?
Unauthorized error will also give a 401 Unauthorized, with message 'you must be logged in to make this request.'
If neither are what you need then you might need to introduce translations into your plugin.
Contributor
Author
There was a problem hiding this comment.
Unauthorized is what we want in this case. I'll export and use that.
kendelljoseph
changed the title
Contributor
|
🚀 This is included in version v3.64.0 |
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.
overrideAuthto the MCP Plugin.MCPAccessSettingsas an exported type from the mcpPluginCustom Auth Behaviors
The bypassed system uses an API Key that contains
MCPAccessSettingsinformation. TheoverrideAuthfunction will bypass the API Key system and use your function when authorizing requests.This means that your function must return a valid
MCPAccessSettingsobject to use.