Skip to content

Update readme #674

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Add the following JSON block to your IDE MCP settings.
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"GITHUB_PERSONAL_ACCESS_TOKEN=${input:github_token}",
"ghcr.io/github/github-mcp-server"
],
"env": {
Expand Down Expand Up @@ -195,7 +195,7 @@ Optionally, you can add a similar example (i.e. without the mcp key) to a file c
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"GITHUB_PERSONAL_ACCESS_TOKEN=${input:github_token}",
"ghcr.io/github/github-mcp-server"
],
"env": {
Expand All @@ -221,7 +221,7 @@ More about using MCP server tools in VS Code's [agent mode documentation](https:
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"GITHUB_PERSONAL_ACCESS_TOKEN=<YOUR_TOKEN>",
"ghcr.io/github/github-mcp-server"
],
"env": {
Expand Down Expand Up @@ -378,7 +378,7 @@ the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data r
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"GITHUB_PERSONAL_ACCESS_TOKEN=${input:github_token}",
"-e",
"GITHUB_HOST",
"ghcr.io/github/github-mcp-server"
Expand Down
6 changes: 3 additions & 3 deletions cmd/mcpcurl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The `--stdio-server-cmd` flag is required for all commands and specifies the com
List available tools in Github's MCP server:

```console
% ./mcpcurl --stdio-server-cmd "docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN mcp/github" tools --help
% ./mcpcurl --stdio-server-cmd "docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> ghcr.io/github/github-mcp-server" tools --help
Contains all dynamically generated tool commands from the schema

Usage:
Expand Down Expand Up @@ -73,7 +73,7 @@ Use "mcpcurl tools [command] --help" for more information about a command.
Get help for a specific tool:

```console
% ./mcpcurl --stdio-server-cmd "docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN mcp/github" tools get_issue --help
% ./mcpcurl --stdio-server-cmd "docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> ghcr.io/github/github-mcp-server" tools get_issue --help
Get details of a specific issue in a GitHub repository

Usage:
Expand All @@ -94,7 +94,7 @@ Global Flags:
Use one of the tools:

```console
% ./mcpcurl --stdio-server-cmd "docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN mcp/github" tools get_issue --owner golang --repo go --issue_number 1
% ./mcpcurl --stdio-server-cmd "docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> ghcr.io/github/github-mcp-server" tools get_issue --owner golang --repo go --issue_number 1
{
"active_lock_reason": null,
"assignee": null,
Expand Down