docs(AI): Adds PatternFly MCP documentation.#4857
docs(AI): Adds PatternFly MCP documentation.#4857nicolethoen merged 16 commits intopatternfly:mainfrom
Conversation
| For full technical documentation, setup instructions, and to contribute, visit our [PatternFly MCP GitHub Repository](https://github.com/patternfly/patternfly-mcp). | ||
|
|
||
| ## What is the PatternFly MCP? | ||
| The **PatternFly MCP** is a new tool designed to integrate our design guidelines, component documentation, and accessibility best practices directly into your AI-powered development environment. |
There was a problem hiding this comment.
Seeing "new" in our docs immediately makes me think we're building in tech debt as this becomes dated.
| The **PatternFly MCP** is a new tool designed to integrate our design guidelines, component documentation, and accessibility best practices directly into your AI-powered development environment. | |
| The **PatternFly MCP** is a tool designed to integrate our design guidelines, component documentation, and accessibility best practices directly into your AI-powered development environment. |
evwilkin
left a comment
evwilkin
left a comment
There was a problem hiding this comment.
Added a few small tweaks to help adopt this from our testing overview to our official docs.
One thing potentially missing here is that we're focusing on direct communication with the MCP in all examples - asking it a question and getting an answer to that question. I'd suspect the more common use case is having this work in the background as an always-on reference that's incorporated into existing workflows. For example, a designer vibe coding a design or interactive POC, or developer building/enhancing a product codebase, that automatically pulls in the correct components, props, accessibility considerations, etc. without them needing to specifically ask what that is but just for the agent to be aware of & use that information.
I originally tried to hint at this with the below statement, but not sure how to more clearly indicate the power of the MCP as the magic behind the curtain rather than just a chatbot-style interaction
Here are a few sample prompts to get you started, but the MCP tools are available for reference by your AI agent across all applicable use cases (code generation, design review, etc.):
|
I couldn't get the mcp set up in cursor myself until I added |
@nicolethoen it looks like I was hitting an error with @latest due to a caching issue, clearing my npm cache and trying again with @latest worked just fine 👍 |
|
This should be rebased given the nav redesign - and this page should go under |
|
@evwilkin @nicolethoen I added |
Co-authored-by: Evan <8651509+evwilkin@users.noreply.github.com>
|
@edonehoo following up on this, the tools in the MCP are being finalized in the next week or two and at that point we should be good to update the wording here and move forward - thanks for the patience! 😄 |
|
ty @cdcabrera ! I made those updates, but we can keep refining as needed |
cdcabrera
left a comment
cdcabrera
left a comment
There was a problem hiding this comment.
The MCP tools are the primary thing that need to be updated
|
@cdcabrera ah, my bad! Could've sworn I made those changes, but I must have been half awake 😅 I think I just got to the remainder of what you commented -- lmk if I missed anything. I also added a few links to the repo to try and increase visibility to some of those docs, but we can back those out if you think it's not helpful or if the links are too likely to change |
|
|
||
| MCP stands for Model Context Protocol, an open standard that allows AI assistants to securely and accurately access external data sources and tools. The PatternFly MCP is a server that connects your AI assistant (like those within Cursor or Claude Code) directly to official PatternFly documentation. Instead of relying on a model's potentially outdated or overgeneralized knowledge, your assistant can query the PatternFly MCP to get answers based on real, up-to-date, and verified sources. | ||
|
|
||
| Beyond offering these enhanced AI assistant conversations, the PatternFly MCP can also work in the background and incorporate into your existing workflows. For example, it can ensure that vibe coding will automatically utilize the latest and most applicable PatternFly elements, without requiring you to specifically ask an assistant to do so. It will quietly supply an assistant with the information necessary to make these recommendations and decisions. |
There was a problem hiding this comment.
PatternFly elements
Not blocking but flagging this for potential confusion with PFE
evwilkin
left a comment
evwilkin
left a comment
There was a problem hiding this comment.
LGTM - added 1 callout of using "PatternFly elements" text which could cause potential confusion.
|
Your changes have been released in:
Thanks for your contribution! 🎉 |
5 participants
Closes #4844
This PR adds a new page to patternfly.org in the PatternFly AI section explaining & overviewing the PatternFly MCP.
Preview: https://pf-org--pr-4857-site.surge.sh/ai/patternfly-mcp