From 81f96b12cbdc7af9d10b331690c3a1a7141775b7 Mon Sep 17 00:00:00 2001 From: JoannaaKL Date: Tue, 20 Jan 2026 10:00:54 +0100 Subject: [PATCH 1/2] Add -t option to docker run command --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f1cda8fa..4322c7834 100644 --- a/README.md +++ b/README.md @@ -345,8 +345,10 @@ The `github-mcp-server` binary includes a few CLI subcommands that are helpful f - `github-mcp-server tool-search ""` searches tools by name, description, and input parameter names. Use `--max-results` to return more matches. Example: +> **Note:** Color output requires a TTY. Use `docker run -t` (or `-it`) when running in Docker. + ```bash -docker run -i --rm ghcr.io/github/github-mcp-server tool-search "issue" --max-results 5 +docker run -it --rm ghcr.io/github/github-mcp-server tool-search "issue" --max-results 5 github-mcp-server tool-search "issue" --max-results 5 ``` From 9379c0dd897dcb3da69696f8feab1d53c615c146 Mon Sep 17 00:00:00 2001 From: JoannaaKL Date: Tue, 20 Jan 2026 10:06:28 +0100 Subject: [PATCH 2/2] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 4322c7834..207c2b05f 100644 --- a/README.md +++ b/README.md @@ -343,10 +343,7 @@ If you don't have Docker, you can use `go build` to build the binary in the The `github-mcp-server` binary includes a few CLI subcommands that are helpful for debugging and exploring the server. - `github-mcp-server tool-search ""` searches tools by name, description, and input parameter names. Use `--max-results` to return more matches. -Example: - -> **Note:** Color output requires a TTY. Use `docker run -t` (or `-it`) when running in Docker. - +Example (color output requires a TTY; use `docker run -t` (or `-it`) when running in Docker): ```bash docker run -it --rm ghcr.io/github/github-mcp-server tool-search "issue" --max-results 5 github-mcp-server tool-search "issue" --max-results 5