clean up and add tests for missing API key

Author: Andrew-Paystack

README.md

@@ -46,7 +46,22 @@ You can provide your API key in two ways:
 
 The Paystack MCP Server works with any MCP-compatible client. Below is the standard configuration schema used by most clients (Claude Desktop, ChatGPT Desktop, Cursor, Windsurf, etc.).
 
-### Using npm (recommended)\n\nFor npm-installed server:\n\n```json\n{\n  \"mcpServers\": {\n    \"paystack\": {\n      \"command\": \"npx\",\n      \"args\": [\"@paystack/mcp-server\", \"--api-key\", \"sk_test_...\"]\n    }\n  }\n}\n```\n\n### Using a local build
+### Using npm (recommended)
+
+For npm-installed server:
+
+```json
+{
+  "mcpServers": {
+    "paystack": {
+      "command": "npx",
+      "args": ["@paystack/mcp-server", "--api-key", "sk_test_..."]
+    }
+  }
+}
+```
+
+### Using a local build
 
 If you've cloned and built the server locally:
 

package-lock.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/PaystackOSS/paystack-mcp-server.git"
   },
   "bin": {
-    "paystack-mcp": "./build/index.js"
+    "paystack-mcp-server": "./build/index.js"
   },
   "scripts": {
     "build": "tsc && cp -r src/data build/",
@@ -33,7 +33,8 @@
   "dependencies": {
     "@modelcontextprotocol/inspector": "^0.18.0",
     "@modelcontextprotocol/sdk": "^1.26.0",
-    "dotenv": "^17.2.3"  
+    "dotenv": "^17.2.3",
+    "zod": "^4.3.6"
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "^12.1.0",

package.json

@@ -29,9 +29,6 @@ export function getConfig(cliApiKey?: string) {
   };
 }
 
-// Export validated configuration (for backward compatibility, will use env var)
-export const config = getConfig();
-
 // Paystack API configuration factory
 export function createPaystackConfig(cliApiKey?: string) {
   const cfg = getConfig(cliApiKey);
@@ -41,6 +38,3 @@ export function createPaystackConfig(cliApiKey?: string) {
     timeout: 30000, // 30 seconds
   } as const;
 }
-
-// Default paystack config (for backward compatibility)
-export const paystackConfig = createPaystackConfig();

src/config.ts

@@ -1,5 +1,3 @@
-#!/usr/bin/env node
-import { startServer } from "./server";
 
 // Simple CLI argument parsing
 function parseApiKey(): string | undefined {
@@ -41,15 +39,12 @@ async function main() {
     process.exit(0);
   }
 
+  const { startServer } = await import("./server");
+
   // Parse API key from CLI
   const cliApiKey = parseApiKey();
 
-  // Validate API key format if provided via CLI
-  if (cliApiKey && !cliApiKey.startsWith('sk_test_')) {
-    console.error('Error: API key must start with "sk_test_". Only test keys are allowed.');
-    process.exit(1);
-  }
-  
+ 
   // Check if we have an API key from CLI or environment
   if (!cliApiKey && !process.env.PAYSTACK_TEST_SECRET_KEY) {
     console.error('Error: Paystack API key required.');

src/index.ts

@@ -1,4 +1,4 @@
-import { config } from './config.js';
+import { getConfig } from './config.js';
 // Define log levels
 export enum LogLevel {
   DEBUG = 'debug',
@@ -92,8 +92,8 @@ function redactSensitiveData(obj: any): any {
 class Logger {
   private currentLogLevel: LogLevel;
 
-  constructor() {
-    this.currentLogLevel = config.LOG_LEVEL as LogLevel;
+  constructor(logLevel?: LogLevel) {
+    this.currentLogLevel = logLevel || LogLevel.INFO;
   }
 
   private shouldLog(level: LogLevel): boolean {
@@ -175,4 +175,13 @@ class Logger {
   }
 }
 
+/**
+ * Create a logger instance with configuration
+ */
+export function createLogger(cliApiKey?: string): Logger {
+  const config = getConfig(cliApiKey);
+  return new Logger(config.LOG_LEVEL as LogLevel);
+}
+
+// Default logger instance for backward compatibility (uses environment variable)
 export const logger = new Logger();

src/logger.ts

@@ -1,7 +1,7 @@
 import { PaystackResponse, PaystackError } from "./types";
-import { paystackConfig } from "./config";
+import { createPaystackConfig } from "./config";
 
-const PAYSTACK_BASE_URL = paystackConfig.baseURL;
+const PAYSTACK_BASE_URL = 'https://api.paystack.co';
 const USER_AGENT = process.env.USER_AGENT || 'Paystack-MCP-Server/0.0.1';
 
 export class PaystackClient {
@@ -92,7 +92,10 @@ export class PaystackClient {
 }
 }
 
-// Export singleton instance for backward compatibility 
-export const paystackClient = new PaystackClient(
-  paystackConfig.secretKey
-);
+/**
+ * Create a PaystackClient instance with configuration
+ */
+export function createPaystackClient(cliApiKey?: string): PaystackClient {
+  const config = createPaystackConfig(cliApiKey);
+  return new PaystackClient(config.secretKey, config.baseURL, undefined, config.timeout);
+}

src/paystack-client.ts

@@ -17,7 +17,8 @@ describe("MakePaystackRequestTool", () => {
         }
       } as any;
 
-      registerMakePaystackRequestTool(server);
+      // Pass a test API key to avoid environment variable requirement  
+      registerMakePaystackRequestTool(server, "sk_test_1234567890abcdef1234567890abcdef12345678");
     });
 
     it("should return isError: true for non-JSON responses", async () => {
@@ -145,4 +146,52 @@ describe("MakePaystackRequestTool", () => {
       }
     });
   });
+  describe("Missing API Key Validation", () => {
+    let server: McpServer;
+    let originalExit: typeof process.exit;
+    let exitCode: number | undefined;
+    let consoleErrors: string[] = [];
+    let originalConsoleError: typeof console.error;
+
+    beforeEach(() => {
+      // Mock process.exit to capture exit calls
+      exitCode = undefined;
+      originalExit = process.exit;
+      process.exit = ((code?: number) => {
+        exitCode = code || 0;
+        throw new Error(`Process would exit with code ${exitCode}`);
+      }) as any;
+
+      // Mock console.error to capture error messages
+      consoleErrors = [];
+      originalConsoleError = console.error;
+      console.error = (...args: any[]) => {
+        consoleErrors.push(args.join(' '));
+      };
+
+      server = {
+        registerTool: (name: string, config: any, handler: any) => { }
+      } as any;
+    });
+
+    afterEach(() => {
+      process.exit = originalExit;
+      console.error = originalConsoleError;
+      delete process.env.PAYSTACK_TEST_SECRET_KEY;
+    });
+
+    it("should fail when no API key provided via CLI or environment", () => {
+      // Ensure no environment variable is set
+      delete process.env.PAYSTACK_TEST_SECRET_KEY;
+
+      try {
+        registerMakePaystackRequestTool(server); // No cliApiKey parameter
+        assert.fail("Expected registerMakePaystackRequestTool to throw an error");
+      } catch (error: any) {
+        assert.ok(error.message.includes("Process would exit with code 1"));
+        assert.strictEqual(exitCode, 1);
+        assert.ok(consoleErrors.some(msg => msg.includes("PAYSTACK_TEST_SECRET_KEY is required")));
+      }
+    });
+  });
 });

test/make-paystack-request-tool.spec.ts

@@ -1,7 +1,10 @@
 import assert from "node:assert";
-import { paystackClient } from "../src/paystack-client.js";
+import { createPaystackClient } from "../src/paystack-client.js";
 
 describe("PaystackClient", () => {
+  // Use a test API key for the test client
+  const paystackClient = createPaystackClient("sk_test_1234567890abcdef1234567890abcdef12345678");
+  
   describe("makeRequest - Non-JSON Response Handling", () => {
     it("should throw a descriptive error for HTML error responses", async () => {
       // This test validates that non-JSON responses (like HTML error pages)