Skip to content

Minor additions to gitignore and readme #222

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

Minor additions to gitignore and readme #222

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54f360b
Ignore other local vscode configuration
tonytrg Apr 11, 2025
09c49bc
minor edits for gitignore and readme
tonytrg Apr 11, 2025
b752bb4
Update README.md
tonytrg Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
.idea
cmd/github-mcp-server/github-mcp-server

# Added by goreleaser init:
dist/
__debug_bin*
__debug_bin*

# Explicitly allow vscode configuration
.vscode/*
!.vscode/launch.json

# Ignore go binaries
cmd/github-mcp-server/github-mcp-server
github-mcp-server
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ automation and interaction capabilities for developers and tools.
2. Once Docker is installed, you will also need to ensure Docker is running.
3. Lastly you will need to [Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).
The MCP server can use many of the GitHub APIs, so enable the permissions that you feel comfortable granting your AI tools (to learn more about access tokens, please check out the [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)).

* Your PAT Token needs at least `read:packages` permission to be able to pull from `ghcr.io`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Did you run into some issue here? As far as I'm aware the image is public and:

You can also access public container images anonymously.

https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#about-the-container-registry

Copy link
Contributor Author

@tonytrg tonytrg Apr 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

ah whoops ignore this pr for now :)

I just tested and it works without the pat.

I had some issues with the setup earlier. So I wiped everything and go through every option in the readme to check if I can add useful stuff to the readme.

4. Login via `docker login ghcr.io -u <YOUR_GITHUB_USERNAME> -p <YOUR_GITHUB_PAT>`.


## Installation
Expand Down