Skip to content

[docs] Add introduction to MCP #46224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Jun 23, 2025
Merged

Conversation

bharatkashyap
Copy link
Contributor

@bharatkashyap bharatkashyap commented May 27, 2025

@bharatkashyap bharatkashyap added the docs Improvements or additions to the documentation. label May 27, 2025
@mui-bot
Copy link

mui-bot commented May 27, 2025

Netlify deploy preview

Bundle size report

Bundle Parsed Size Gzip Size
@mui/material 0B(0.00%) 0B(0.00%)
@mui/lab 0B(0.00%) 0B(0.00%)
@mui/system 0B(0.00%) 0B(0.00%)
@mui/utils 0B(0.00%) 0B(0.00%)

Details of bundle changes

Generated by 🚫 dangerJS against 664201e

@zannager zannager requested a review from mapache-salvaje May 28, 2025 15:12
@oliviertassinari oliviertassinari marked this pull request as draft May 29, 2025 11:22
@bharatkashyap bharatkashyap marked this pull request as ready for review June 2, 2025 10:22

## Why MCP?

Traditional AI coding assistants are excellent at providing answers, especially to straightforward questions. However, when faced with a deeper, more complex question which requires understanding concepts from multiple parts of the documentation, they often hallucinate links, cite non-existent documentation, or provide answers that are hard to verify. MCP solves these problems by:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Traditional -> Generic ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to refer to the ones being used the most, so "traditional" - but "popular" might be a better one as well

- Linking to **actual documentation** _(no imaginary links that lead to 404s)_
- Using component code from officially published registries

## Getting Started: Installation & Setup
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Getting Started: Installation & Setup
## Installation & Setup


## What is MCP?

The Model Context Protocol (MCP) is a new open standard for connecting AI assistants to real, trusted sources of documentation and code. For Material UI users, this means you get answers that are accurate, up-to-date, and directly reference the official docs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @bharatkashyap 👋 can you please format this as one sentence per line? This will make it easier to do a line-by-line review and maintain over time.

Suggested change
The Model Context Protocol (MCP) is a new open standard for connecting AI assistants to real, trusted sources of documentation and code. For Material UI users, this means you get answers that are accurate, up-to-date, and directly reference the official docs.
The Model Context Protocol (MCP) is an open standard for connecting AI assistants to real, trusted sources of documentation and code.
For Material UI users, this means you get answers that are accurate, up-to-date, and directly reference the official docs.

@danilo-leal
Copy link
Collaborator

Y'all are missing one editor on this page... 😄

@bharatkashyap
Copy link
Contributor Author

Y'all are missing one editor on this page... 😄

Hahaha, very open to a commit from you to add the Zed instructions 😄

Copy link
Member

@joserodolfofreitas joserodolfofreitas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reads great, let's ship this! 🚀
(Including Zed's section 🙂)

@bharatkashyap bharatkashyap merged commit d9b9b90 into mui:master Jun 23, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants