diff --git a/README.md b/README.md index 6f1cda8fa..207c2b05f 100644 --- a/README.md +++ b/README.md @@ -343,10 +343,9 @@ 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: - +Example (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 ```