Use createLogger helper from logging.ts in documentation

- Add createLogger() helper function to logging.ts
- Update all documentation examples to use createLogger instead of directly importing debug
- Maintains namespace pattern 'mcp:<name>' internally
- Addresses feedback to use helper function from logging.ts

Co-authored-by: pelikhan <[email protected]>

Author: Copilot

AGENTS.md

@@ -86,10 +86,10 @@ maintain consistency across the codebase.
 **Example:**
 
 ```typescript
-import debug from 'debug'
+import { createLogger } from './logging.js'
 
 // Create a dedicated logger for this file
-const log = debug('mcp:server')
+const log = createLogger('server')
 
 // Use the logger throughout your code
 log('Starting MCP proxy')
@@ -168,8 +168,8 @@ log('API key (first 8 chars): %s...', apiKey?.substring(0, 8) || 'not set')
 
 When adding new functionality:
 
-1. Import `debug` at the top of your file
-2. Create a dedicated logger instance with a unique namespace
+1. Import `createLogger` from `./logging.js` at the top of your file
+2. Create a dedicated logger instance with a unique name for your file
 3. Add log statements at key execution points:
    - Function entry points
    - Before/after important operations
@@ -181,9 +181,9 @@ When adding new functionality:
 **Example pattern:**
 
 ```typescript
-import debug from 'debug'
+import { createLogger } from './logging.js'
 
-const log = debug('mcp:myfile')
+const log = createLogger('myfile')
 
 export async function myFunction(param: string): Promise<void> {
   log('myFunction called with param: %s', param)

dist/index.js.map

@@ -16,3 +16,12 @@ export function setupDebugLogging(logDir: string): debug.Debugger {
   log(`Logging to ${logfile}`)
   return log
 }
+
+/**
+ * Create a logger for a specific file/component.
+ * @param name - The name of the file/component (e.g., 'server', 'docker', 'port')
+ * @returns A debug logger instance with namespace 'mcp:<name>'
+ */
+export function createLogger(name: string): debug.Debugger {
+  return debug(`mcp:${name}`)
+}