From 387a47eec4c2d521728f74b53f62068ad2041419 Mon Sep 17 00:00:00 2001 From: Chris Rose Date: Thu, 17 Apr 2025 07:26:57 -0700 Subject: [PATCH 1/4] Added installation instructions for Mise. --- README.md | 61 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 40 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index bf0bcce3..8525ab86 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,28 @@ The MCP server can use many of the GitHub APIs, so enable the permissions that y ## Installation +### Usage with Claude Desktop + +```json +{ + "mcpServers": { + "github": { + "command": "docker", + "args": [ + "run", + "-i", + "--rm", + "-e", + "GITHUB_PERSONAL_ACCESS_TOKEN", + "ghcr.io/github/github-mcp-server" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "" + } + } + } +``` + ### Usage with VS Code For quick installation, use one of the one-click install buttons at the top of this README. @@ -64,28 +86,25 @@ Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace More about using MCP server tools in VS Code's [agent mode documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers). -### Usage with Claude Desktop +### Using Mise for Installation -```json -{ - "mcpServers": { - "github": { - "command": "docker", - "args": [ - "run", - "-i", - "--rm", - "-e", - "GITHUB_PERSONAL_ACCESS_TOKEN", - "ghcr.io/github/github-mcp-server" - ], - "env": { - "GITHUB_PERSONAL_ACCESS_TOKEN": "" - } - } - } -} -``` +To quickly configure and deploy the GitHub MCP Server in your environment, you can use **[Mise](https://mise.jdx.dev)**, a deployment and configuration tool optimized for developer workflows. + +Here’s how to get started: + +1. Install `mise` by following the installation instructions at [https://mise.jdx.dev](https://mise.jdx.dev). +2. Use the following command to deploy the GitHub MCP Server configuration: + + ```bash + mise deploy github-mcp-server --token= --use-docker + ``` + + - Replace `` with your GitHub personal access token. + - Use `--use-docker` to run the server via Docker. + +3. Confirm that the server is running using `mise status`. + +For more details, see [Mise's official documentation](https://mise.jdx.dev/docs). ### Build from source From 41b568d2230f75dfde6ddd268142076b0b150e5b Mon Sep 17 00:00:00 2001 From: Chris Rose Date: Thu, 17 Apr 2025 07:40:33 -0700 Subject: [PATCH 2/4] Fix the vibe-based hallucinations in the mise instructions --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8525ab86..dc3f9ef7 100644 --- a/README.md +++ b/README.md @@ -88,22 +88,17 @@ More about using MCP server tools in VS Code's [agent mode documentation](https: ### Using Mise for Installation -To quickly configure and deploy the GitHub MCP Server in your environment, you can use **[Mise](https://mise.jdx.dev)**, a deployment and configuration tool optimized for developer workflows. +To quickly configure and deploy the GitHub MCP Server in your environment, you can use **[Mise](https://mise.jdx.dev)**, a developer tool manager Here’s how to get started: 1. Install `mise` by following the installation instructions at [https://mise.jdx.dev](https://mise.jdx.dev). -2. Use the following command to deploy the GitHub MCP Server configuration: +2. Use the following command to install the latest build of github-mcp-server ```bash - mise deploy github-mcp-server --token= --use-docker + mise use -g ubi:github/github-mcp-server ``` - - Replace `` with your GitHub personal access token. - - Use `--use-docker` to run the server via Docker. - -3. Confirm that the server is running using `mise status`. - For more details, see [Mise's official documentation](https://mise.jdx.dev/docs). ### Build from source From 25ecb73c41b5ff2b26646fb039e1dfe039a9afbe Mon Sep 17 00:00:00 2001 From: Chris Rose Date: Thu, 17 Apr 2025 07:41:29 -0700 Subject: [PATCH 3/4] Restore the ordering of VSCode vs Claude --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index dc3f9ef7..ab36d1a9 100644 --- a/README.md +++ b/README.md @@ -21,28 +21,6 @@ The MCP server can use many of the GitHub APIs, so enable the permissions that y ## Installation -### Usage with Claude Desktop - -```json -{ - "mcpServers": { - "github": { - "command": "docker", - "args": [ - "run", - "-i", - "--rm", - "-e", - "GITHUB_PERSONAL_ACCESS_TOKEN", - "ghcr.io/github/github-mcp-server" - ], - "env": { - "GITHUB_PERSONAL_ACCESS_TOKEN": "" - } - } - } -``` - ### Usage with VS Code For quick installation, use one of the one-click install buttons at the top of this README. @@ -86,6 +64,28 @@ Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace More about using MCP server tools in VS Code's [agent mode documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers). +### Usage with Claude Desktop + +```json +{ + "mcpServers": { + "github": { + "command": "docker", + "args": [ + "run", + "-i", + "--rm", + "-e", + "GITHUB_PERSONAL_ACCESS_TOKEN", + "ghcr.io/github/github-mcp-server" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "" + } + } + } +``` + ### Using Mise for Installation To quickly configure and deploy the GitHub MCP Server in your environment, you can use **[Mise](https://mise.jdx.dev)**, a developer tool manager From e0943f729edce8598948b149d139d267dca62839 Mon Sep 17 00:00:00 2001 From: Chris Rose Date: Thu, 17 Apr 2025 07:42:02 -0700 Subject: [PATCH 4/4] fixup! Restore the ordering of VSCode vs Claude --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ab36d1a9..fbb88f27 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,7 @@ More about using MCP server tools in VS Code's [agent mode documentation](https: } } } +} ``` ### Using Mise for Installation