Refine Sentry and logging

Author: cameroncooke

.eslintrc.js

@@ -28,7 +28,7 @@ export default [
         argsIgnorePattern: '^_',
         varsIgnorePattern: '^_' 
       }],
-      'no-console': ['warn', { allow: ['warn', 'error'] }],
+      'no-console': ['warn', { allow: ['error'] }],
     },
   },
 ];

eslint.config.js

@@ -51,5 +51,5 @@ export function createServer(): McpServer {
 export async function startServer(server: McpServer): Promise<void> {
   const transport = new StdioServerTransport();
   await server.connect(transport);
-  console.error('XcodeBuildMCP Server running on stdio');
+  log('info', 'XcodeBuildMCP Server running on stdio');
 }

src/server/server.ts

@@ -29,7 +29,7 @@ const LOG_PREFIX = '[Diagnostic]';
  * @param binary The binary name to check
  * @returns Object with availability status and optional version string
  */
-function checkBinaryAvailability(binary: string): { available: boolean; version?: string } {
+export function checkBinaryAvailability(binary: string): { available: boolean; version?: string } {
   // First check if the binary exists at all
   try {
     execSync(`which ${binary}`, { stdio: 'ignore' });
@@ -82,7 +82,7 @@ function checkBinaryAvailability(binary: string): { available: boolean; version?
 /**
  * Get information about the Xcode installation
  */
-function getXcodeInfo():
+export function getXcodeInfo():
   | { version: string; path: string; selectedXcode: string; xcrunVersion: string }
   | { error: string } {
   try {
@@ -106,7 +106,7 @@ function getXcodeInfo():
 /**
  * Get information about the environment variables
  */
-function getEnvironmentVariables(): Record<string, string | undefined> {
+export function getEnvironmentVariables(): Record<string, string | undefined> {
   const relevantVars = [
     'XCODEBUILDMCP_DEBUG',
     'XCODEMAKE_ENABLED',

src/tools/diagnostic.ts

@@ -128,7 +128,10 @@ async function _findProjectsRecursive(
     if (code === 'EPERM' || code === 'EACCES') {
       log('debug', `Permission denied scanning directory: ${currentDirAbs}`);
     } else {
-      log('warn', `Error scanning directory ${currentDirAbs}: ${message} (Code: ${code ?? 'N/A'})`);
+      log(
+        'warning',
+        `Error scanning directory ${currentDirAbs}: ${message} (Code: ${code ?? 'N/A'})`,
+      );
     }
   }
 }

src/tools/discover_projects.ts

@@ -74,7 +74,7 @@ async function executeIdbCommand(
         log('debug', `${LOG_PREFIX}: Command "${commandName}" exited with code ${code}`);
         log('debug', `${LOG_PREFIX}: stdout:\n${stdoutData}`);
         if (stderrData) {
-          log('warn', `${LOG_PREFIX}: stderr:\n${stderrData}`);
+          log('warning', `${LOG_PREFIX}: stderr:\n${stderrData}`);
         }
 
         if (processError) {
@@ -594,7 +594,7 @@ export function registerIdbTools(server: McpServer): void {
 
           // Clean up the temporary file
           await fs.unlink(screenshotPath).catch((err) => {
-            log('warn', `${LOG_PREFIX}/${toolName}: Failed to delete temporary file: ${err}`);
+            log('warning', `${LOG_PREFIX}/${toolName}: Failed to delete temporary file: ${err}`);
           });
 
           // Return the image directly in the tool response

src/tools/idb.ts

@@ -19,23 +19,26 @@
 
 import * as Sentry from '@sentry/node';
 
-const SENTRY_DISABLED = process.env.SENTRY_DISABLED === 'true';
+const SENTRY_ENABLED = process.env.SENTRY_DISABLED !== 'true';
+
+if (!SENTRY_ENABLED) {
+  log('info', 'Sentry disabled due to SENTRY_DISABLED environment variable');
+}
 
 /**
  * Log a message with the specified level
  * @param level The log level (info, warning, error, debug)
  * @param message The message to log
- * @param context Optional context data to include with error logs sent to Sentry
  */
-export function log(level: string, message: string, context?: Record<string, unknown>): void {
+export function log(level: string, message: string): void {
   const timestamp = new Date().toISOString();
-  console.error(`[${timestamp}] [${level.toUpperCase()}] ${message}`);
+  const logMessage = `[${timestamp}] [${level.toUpperCase()}] ${message}`;
 
-  // Send error logs to Sentry unless disabled
-  if (!SENTRY_DISABLED && level.toLowerCase() === 'error') {
-    Sentry.captureMessage(message, {
-      level: 'error',
-      extra: context,
-    });
+  if (level === 'error' && SENTRY_ENABLED) {
+    Sentry.captureMessage(logMessage);
   }
+
+  // It's important to use console.error here to ensure logs don't interfere with MCP protocol communication
+  // see https://modelcontextprotocol.io/docs/tools/debugging#server-side-logging
+  console.error(logMessage);
 }

src/utils/logger.ts

@@ -7,6 +7,11 @@
 
 import * as Sentry from '@sentry/node';
 import { version } from '../version.js';
+import {
+  getXcodeInfo,
+  getEnvironmentVariables,
+  checkBinaryAvailability,
+} from '../tools/diagnostic.js';
 
 Sentry.init({
   dsn: 'https://798607831167c7b9fe2f2912f5d3c665@o4509258288332800.ingest.de.sentry.io/4509258293837904',
@@ -27,8 +32,29 @@ Sentry.init({
 });
 
 // Add additional context that might be helpful for debugging
-Sentry.setTags({
+const tags: Record<string, string> = {
   nodeVersion: process.version,
   platform: process.platform,
   arch: process.arch,
-});
+};
+
+// Only add Xcode Info if it's available
+const xcodeInfo = getXcodeInfo();
+if ('version' in xcodeInfo) {
+  tags.xcodeVersion = xcodeInfo.version;
+  tags.xcrunVersion = xcodeInfo.xcrunVersion;
+} else {
+  tags.xcodeVersion = 'Unknown';
+  tags.xcrunVersion = 'Unknown';
+}
+
+const envVars = getEnvironmentVariables();
+tags.env_XCODEBUILDMCP_DEBUG = envVars.XCODEBUILDMCP_DEBUG || 'false';
+tags.env_XCODEMAKE_ENABLED = envVars.XCODEMAKE_ENABLED || 'false';
+tags.env_XCODEBUILDMCP_RUNNING_UNDER_MISE = envVars.XCODEBUILDMCP_RUNNING_UNDER_MISE || 'false';
+
+const miseAvailable = checkBinaryAvailability('mise');
+tags.miseAvailable = miseAvailable.available ? 'true' : 'false';
+tags.miseVersion = miseAvailable.version || 'Unknown';
+
+Sentry.setTags(tags);