Skip to content

fix:README.md missing character#303

Merged
olaservo merged 3 commits into
modelcontextprotocol:mainfrom
ZhengkaiWang:fix_readme_missing_character
Apr 16, 2025
Merged

fix:README.md missing character#303
olaservo merged 3 commits into
modelcontextprotocol:mainfrom
ZhengkaiWang:fix_readme_missing_character

Conversation

@ZhengkaiWang
Copy link
Copy Markdown
Contributor

Fix missing 'node' command in README.md

This PR fixes a missing node command in the README.md file. The current documentation omits this necessary command prefix in one of the instructions, which could cause confusion for users trying to follow the setup steps.

Motivation and Context

When following the instructions in the README.md, users would encounter an error because one command line is missing the node prefix. This small documentation fix ensures that users can successfully execute the commands as written without having to troubleshoot or infer the missing part.

How Has This Been Tested?

I verified that the command works correctly with the node prefix added. The documentation now accurately reflects the correct command syntax needed to run the tool.

Breaking Changes

None. This is purely a documentation fix that doesn't affect any functionality.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

This is a simple documentation fix to ensure users can correctly execute the commands provided in the README without confusion. Proper documentation helps reduce setup issues and improves developer experience.

Copy link
Copy Markdown
Member

@olaservo olaservo left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this! Checking for a couple other incoming updates to Readme before merging to avoid needing to fix conflicts again in a previous MR.

@olaservo olaservo merged commit 8e8a5bb into modelcontextprotocol:main Apr 16, 2025
2 checks passed
IgnacioC44 referenced this pull request in MCPJam/inspector Jun 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants