Skip to content
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

docs: fix error in README code snippet #425

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ilechuks73
Copy link

Corrected an error in the Github NPX code snippet within the README file to ensure accuracy and usability. The updated snippet aligns with the intended functionality and improves developer experience.

Description

After copying the code snippet for the github server with NPX execution, i started getting linting errors until i compared with docker snippet and notices the difference in the location of the env key

Server Details

  • Server:
  • Changes to:

Motivation and Context

For a first timer, it is very difficult to spot this error and took patience and me rereading the docs to spot it since claude desktop error message is of no help

How Has This Been Tested?

Breaking Changes

No

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 Protocol Documentation
  • My changes follows MCP security best practices
  • I have updated the server's README accordingly
  • I have tested this with an LLM client
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have documented all environment variables and configuration options

Additional context

None

Corrected an error in the Github NPX code snippet within the README file to ensure accuracy and usability. The updated snippet aligns with the intended functionality and improves developer experience.
Copy link

@nyarundapeter nyarundapeter left a comment

Choose a reason for hiding this comment

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

Great work on addressing the issue and implementing the fix.
I was just about to make a similar PR.
The code works as expected and Github connects as expected.

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.

2 participants