wip: readme updates

Author: toby

README.md

@@ -8,86 +8,51 @@ The GitHub MCP Server is a Model Context Protocol (MCP) server that provides sea
 - Extracting and analyzing data from GitHub repositories.
 - Building AI powered tools and applications that interact with GitHub's ecosystem.
 
-## Installation
-
-[Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with the appropriate permissions and set it as the `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable.
+## Prerequisites
 
-### Start VS Code Insiders
+[Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with the permissions you want to give the MCP server. You can also install [Docker](https://www.docker.com/) to run the server in a container or build the binary from the repo.
 
-Start VS Code Insiders and make sure you pass the `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable to the process.
+## Installation
 
-One way to do this is to make sure that [you can run VS code from your terminal](https://code.visualstudio.com/docs/setup/mac#_launch-vs-code-from-the-command-line) and
-start it with the following command:
+### Usage with VS Code
 
 ```bash
-export GITHUB_PERSONAL_ACCESS_TOKEN=your-token-here
-code-insiders
-```
-
-Another way is to set the environment variable in your shell configuration file (e.g., `.bashrc`, `.zshrc`, etc.).
+code --add-mcp '{"name":"github","command":"docker","args":["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server:main"], "env": {"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github-pat}"} "inputs": [ { "id": "github-pat", "type": "promptString", "description": "Github Personal Access Token", "password": true, } ] }'
 
-Create a new file `.vscode/mcp.json` and provide this configuration:
-
-If you are using the docker image, use this configuration:
-
-```json
-{
-    "inputs": [
-        {
-            "id": "github-pat",
-            "type": "promptString",
-            "description": "Github Personal Access Token",
-            "password": true,
-        }
-    ],
-    "servers": {
-        "github-mcp-server": {
-        "type": "stdio",
-        "command": "docker",
-            "args": [
-                "run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server:main"
-            ],
-            "env": {
-                "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github-pat}"
-            }
-        }
-    }
-}
 ```
+When you start the server, VS Code will prompt for your token, as indicated by `${input:github-pat}`. On top of `servers`, you should see a `Start` link to start the server.
 
-When you start the server, VS Code will prompt for your token, as indicated by `${input:github-pat}`.
-
-If you built the binary from the repo use this configuration:
+### Usage with Claude Desktop
 
 ```json
 {
-  "mcp": {
-    "inputs": [ ],
-    "servers": {
-      "mcp-github-server": {
-        "command": "path-to-your/github-mcp-server",
-        "args": ["stdio"],
-        "env": {   }
+  "mcpServers": {
+    "github": {
+      "command": "docker",
+      "args": [
+        "run",
+        "-i",
+        "--rm",
+        "-e",
+        "GITHUB_PERSONAL_ACCESS_TOKEN",
+        "ghcr.io/github/github-mcp-server:main"
+      ],
+      "env": {
+        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
       }
     }
   }
 }
 ```
 
-Right on top of `servers`, you should see a `Start` link to start the server.
-
+### Usage with Binary
 
-Try something like the following prompt to verify that it works:
-
-```
-I'd like to know more about my GitHub profile.
-```
+If you don't have Docker, you can build the binary from the repo and use the `github-mcp-server stdio` command with the `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable set to your token.
 
 ## GitHub Enterprise Server
 
 The flag `--gh-host` and the environment variable `GH_HOST` can be used to set the GitHub Enterprise Server hostname.
 
-
 ## Tools
 
 ### Users