Skip to content

[docs] Fix incorrect command for MCP Inspector in mcp.md #46630

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 1 commit into from
Aug 1, 2025

Conversation

EndiM
Copy link
Contributor

@EndiM EndiM commented Jul 31, 2025

This pull request corrects a small but critical typo in the documentation for the MUI Code Patcher (MCP) Inspector.

Problem:

The command provided in mcp.md for running the MCP Inspector is missing a hyphen before the -y flag.

The current documentation suggests:

npx y @mui/mcp@latest

When a user copies and runs this command, it fails because y is not a valid npx command. This can cause confusion for developers trying to use this new and powerful feature for the first time.

Solution:

This PR adds the required hyphen to the command, correcting it to the functional version:

npx -y @mui/mcp@latest

This ensures that the instructions work as expected out of the box, providing a smooth developer experience.

Here is the specific change:

- npx y @mui/mcp@latest
+ npx -y @mui/mcp@latest

…tructions

Testing connection fails inside MCP instructor if we use currently specified value for arguments in documentation - `y @mui/mcp@latest`

Proper arguments value should be `-y @mui/mcp@latest`.

Signed-off-by: Endi Modric <[email protected]>
@mui-bot
Copy link

mui-bot commented Jul 31, 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 88f37f4

@zannager zannager added the docs Improvements or additions to the documentation. label Jul 31, 2025
@zannager zannager requested a review from siriwatknp July 31, 2025 14:57
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli left a comment

Choose a reason for hiding this comment

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

@EndiM In the PR description you are saying MUI Code Patcher (MCP) Inspector. What "code patcher" are you referring to?

Copy link
Member

@ZeeshanTamboli ZeeshanTamboli left a comment

Choose a reason for hiding this comment

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

Tested it locally. Works well! Thanks for the fix.

@ZeeshanTamboli ZeeshanTamboli merged commit 348eb57 into mui:master Aug 1, 2025
23 of 24 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.

4 participants