Skip to content

docs(plugin-mcp): updates MCP plugin documentation#15729

Merged
DanRibbens merged 1 commit intomainfrom
docs/mcp
Mar 10, 2026
Merged

docs(plugin-mcp): updates MCP plugin documentation#15729
DanRibbens merged 1 commit intomainfrom
docs/mcp

Conversation

@kendelljoseph
Copy link
Copy Markdown
Contributor

@kendelljoseph kendelljoseph commented Feb 23, 2026

This PR expands the MCP plugin docs to cover all current features, patterns, and workflows.

New sections added

  • How Access Control Works — step-by-step explanation that plugin config and API Key permissions are two separate gates.
  • Globals — documents find/update tool generation for singleton globals.
  • Reducing Token Usage with select — explains the select JSON string parameter.
  • Modifying Responses — documents the overrideResponse hook on collections and globals.
  • Localization — covers the automatic locale and fallbackLocale parameters added when localization is enabled in Payload config.
  • Tracking MCP Events — documents the onEvent callback in mcp.handlerOptions.
  • Virtual Fields — explains that computed/read-only virtual fields are excluded from create/update schemas but still appear in find responses.
  • Testing Your MCP Endpoint — covers npx @modelcontextprotocol/inspector and direct curl testing workflows.
  • Claude Code Connectorclaude mcp add command snippet for connecting Claude Code as an MCP client

Improvements to existing sections

  • Performance — expanded from a single description tip to four concrete levers: strong descriptions, select, overrideResponse, and least-privilege operation enablement.

@kendelljoseph kendelljoseph marked this pull request as ready for review February 23, 2026 16:25
Comment thread docs/plugins/mcp.mdx
})
```

### Use `select` to return only the fields you need
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.

Similar to this optimization, what about depth?
Is the default depth 0 or should that be documented too?

@kendelljoseph
Copy link
Copy Markdown
Contributor Author

@DanRibbens you should merge these doc updates when you get a chance.

@DanRibbens DanRibbens merged commit b97b4e7 into main Mar 10, 2026
27 checks passed
@DanRibbens DanRibbens deleted the docs/mcp branch March 10, 2026 22:53
@DanRibbens
Copy link
Copy Markdown
Contributor

Done! Thanks @kendelljoseph

@github-actions
Copy link
Copy Markdown
Contributor

🚀 This is included in version v3.79.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants