chore: improve defaults (#50)

Author: ThomasRooney

.changeset/green-lizards-fail.md

@@ -0,0 +1,9 @@
+---
+"@speakeasy-api/docs-mcp-server": patch
+---
+
+Treat blank environment variables as unset when resolving default server metadata.
+
+This fixes cases where `SERVER_NAME`, `SERVER_VERSION`, `GIT_COMMIT`, or `BUILD_DATE`
+are present but set to `""` or whitespace, so the server now falls back to the same
+defaults it would use if those values were omitted entirely.

packages/server/src/defaults.ts

@@ -11,15 +11,16 @@ export function resolveServerName(serverName?: string, toolPrefix?: string): str
     return serverName;
   }
 
-  if (process.env["SERVER_NAME"]) {
-    return process.env["SERVER_NAME"];
+  const envServerName = readOptionalEnv("SERVER_NAME");
+  if (envServerName) {
+    return envServerName;
   }
 
   return toolPrefix ? `${toolPrefix}-docs-server` : PACKAGE_SERVER_NAME;
 }
 
 export function resolveServerVersion(serverVersion?: string): string {
-  return serverVersion ?? process.env["SERVER_VERSION"] ?? PACKAGE_SERVER_VERSION;
+  return serverVersion ?? readOptionalEnv("SERVER_VERSION") ?? PACKAGE_SERVER_VERSION;
 }
 
 export function resolveBuildInfo(input: {
@@ -31,11 +32,16 @@ export function resolveBuildInfo(input: {
   return {
     name: input.name,
     version: input.version,
-    gitCommit: input.gitCommit ?? process.env["GIT_COMMIT"],
-    buildDate: input.buildDate ?? process.env["BUILD_DATE"],
+    gitCommit: input.gitCommit ?? readOptionalEnv("GIT_COMMIT"),
+    buildDate: input.buildDate ?? readOptionalEnv("BUILD_DATE"),
   };
 }
 
+function readOptionalEnv(name: string): string | undefined {
+  const value = process.env[name]?.trim();
+  return value ? value : undefined;
+}
+
 function readPackageVersion(): string {
   const pkg = require("../package.json");
   return typeof pkg?.version === "string" ? pkg.version : "0.0.0";

packages/server/src/test/defaults.test.ts

@@ -0,0 +1,58 @@
+import { afterEach, describe, expect, it } from "vitest";
+import {
+  PACKAGE_SERVER_NAME,
+  PACKAGE_SERVER_VERSION,
+  resolveBuildInfo,
+  resolveServerName,
+  resolveServerVersion,
+} from "../defaults.js";
+
+const ORIGINAL_ENV = {
+  SERVER_NAME: process.env.SERVER_NAME,
+  SERVER_VERSION: process.env.SERVER_VERSION,
+  GIT_COMMIT: process.env.GIT_COMMIT,
+  BUILD_DATE: process.env.BUILD_DATE,
+};
+
+afterEach(() => {
+  process.env.SERVER_NAME = ORIGINAL_ENV.SERVER_NAME;
+  process.env.SERVER_VERSION = ORIGINAL_ENV.SERVER_VERSION;
+  process.env.GIT_COMMIT = ORIGINAL_ENV.GIT_COMMIT;
+  process.env.BUILD_DATE = ORIGINAL_ENV.BUILD_DATE;
+});
+
+describe("defaults", () => {
+  it("treats blank env values as unset", () => {
+    process.env.SERVER_NAME = "   ";
+    process.env.SERVER_VERSION = "";
+    process.env.GIT_COMMIT = " ";
+    process.env.BUILD_DATE = "\t";
+
+    expect(resolveServerName(undefined, "cisco")).toBe("cisco-docs-server");
+    expect(resolveServerVersion()).toBe(PACKAGE_SERVER_VERSION);
+    expect(
+      resolveBuildInfo({ name: PACKAGE_SERVER_NAME, version: PACKAGE_SERVER_VERSION }),
+    ).toEqual({
+      name: PACKAGE_SERVER_NAME,
+      version: PACKAGE_SERVER_VERSION,
+    });
+  });
+
+  it("prefers non-empty env values", () => {
+    process.env.SERVER_NAME = "demo-docs";
+    process.env.SERVER_VERSION = "1.2.3";
+    process.env.GIT_COMMIT = "abc123";
+    process.env.BUILD_DATE = "2026-03-10T00:00:00Z";
+
+    expect(resolveServerName()).toBe("demo-docs");
+    expect(resolveServerVersion()).toBe("1.2.3");
+    expect(
+      resolveBuildInfo({ name: PACKAGE_SERVER_NAME, version: PACKAGE_SERVER_VERSION }),
+    ).toEqual({
+      name: PACKAGE_SERVER_NAME,
+      version: PACKAGE_SERVER_VERSION,
+      gitCommit: "abc123",
+      buildDate: "2026-03-10T00:00:00Z",
+    });
+  });
+});