Include meaningful User-Agent header in requests to the GitHub UI

This adds a custom `User-Agent` header to requests from the
GitHub server to the GitHub API, identifying the application,
the version and key information about the environment.

This aligns with the [recommendations][1] in the GitHub Docs.

As part of this change, I have also moved the current version of
the server into a constant, and fix the initialization of `Server`
to use that version, taking from `package.json`.

[1]: https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api?apiVersion=2022-11-28#user-agent

Author: timrogers

src/github/common/utils.ts

@@ -1,10 +1,12 @@
+import { getUserAgent } from "universal-user-agent";
 import { createGitHubError } from "./errors.js";
+import { VERSION } from "./version.js";
 
 type RequestOptions = {
   method?: string;
   body?: unknown;
   headers?: Record<string, string>;
-};
+}
 
 async function parseResponseBody(response: Response): Promise<unknown> {
   const contentType = response.headers.get("content-type");
@@ -24,13 +26,16 @@ export function buildUrl(baseUrl: string, params: Record<string, string | number
   return url.toString();
 }
 
+const USER_AGENT = `modelcontextprotocol/servers/github/v${VERSION} ${getUserAgent()}`;
+
 export async function githubRequest(
   url: string,
   options: RequestOptions = {}
 ): Promise<unknown> {
   const headers: Record<string, string> = {
     "Accept": "application/vnd.github.v3+json",
     "Content-Type": "application/json",
+    "User-Agent": USER_AGENT,
     ...options.headers,
   };
 

src/github/common/version.ts

@@ -0,0 +1 @@
+export const VERSION = "0.6.2";

src/github/index.ts

@@ -25,11 +25,12 @@ import {
   GitHubConflictError,
   isGitHubError,
 } from './common/errors.js';
+import { VERSION } from "./common/version.js";
 
 const server = new Server(
   {
     name: "github-mcp-server",
-    version: "0.1.0",
+    version: VERSION,
   },
   {
     capabilities: {

src/github/package.json

@@ -23,11 +23,12 @@
     "@types/node": "^22",
     "@types/node-fetch": "^2.6.12",
     "node-fetch": "^3.3.2",
+    "universal-user-agent": "^7.0.2",
     "zod": "^3.22.4",
     "zod-to-json-schema": "^3.23.5"
   },
   "devDependencies": {
     "shx": "^0.3.4",
     "typescript": "^5.6.2"
   }
-}
+}