Add Sentry opt-out

Author: cameroncooke

README.md

@@ -21,6 +21,9 @@ A Model Context Protocol (MCP) server that provides Xcode-related tools for inte
    * [Diagnostic Tool](#diagnostic-tool)
       + [Using with mise](#using-with-mise)
       + [Using with npx](#using-with-npx)
+- [Privacy](#privacy)
+   * [What is sent to Sentry?](#what-is-sent-to-sentry)
+   * [Opting Out of Sentry](#opting-out-of-sentry)
 - [Demos](#demos)
    * [Autonomously fixing build errors in Cursor](#autonomously-fixing-build-errors-in-cursor)
    * [Utilising the new UI automation and screen capture features](#utilising-the-new-ui-automation-and-screen-capture-features)
@@ -158,6 +161,37 @@ The diagnostic tool will output comprehensive information about:
 
 When reporting issues on GitHub, please include the full output from the diagnostic tool to help with troubleshooting.
 
+## Privacy
+
+This project uses [Sentry](https://sentry.io/) for error monitoring and diagnostics. Sentry helps us track issues, crashes, and unexpected errors to improve the reliability and stability of XcodeBuildMCP.
+
+### What is sent to Sentry?
+- Only error-level logs and diagnostic information are sent to Sentry by default.
+- Error logs may include details such as error messages, stack traces, and (in some cases) file paths or project names. You can review the sources in this repository to see exactly what is logged.
+
+### Opting Out of Sentry
+- If you do not wish to send error logs to Sentry, you can opt out by setting the environment variable `SENTRY_DISABLED=true`.
+
+Example MCP client configuration:
+```bash
+{
+  "mcpServers": {
+    "XcodeBuildMCP": {
+      "command": "mise",
+      "args": [
+        "x",
+        "npm:xcodebuildmcp@1.3.2",
+        "--",
+        "xcodebuildmcp"
+      ],
+      "env": {
+        "SENTRY_DISABLED": "true"
+      }        
+    }
+  }
+}
+```
+
 ## Demos
 
 ### Autonomously fixing build errors in Cursor

src/index.ts

@@ -13,8 +13,8 @@
  * - Handling server lifecycle events
  */
 
-// Import Sentry instrumentation at the very top
-import './instrument.js';
+// Import Sentry instrumentation
+import './utils/sentry.js';
 
 // Import server components
 import { createServer, startServer } from './server/server.js';

src/tools/diagnostic.ts

@@ -118,6 +118,7 @@ function getEnvironmentVariables(): Record<string, string | undefined> {
     'TMPDIR',
     'PYTHONPATH',
     'NODE_ENV',
+    'SENTRY_DISABLED',
   ];
 
   const envVars: Record<string, string | undefined> = {};
@@ -262,6 +263,9 @@ export async function runDiagnosticTool(_params: unknown): Promise<ToolResponse>
     `- Build Tools: ${!('error' in diagnosticInfo.xcode) ? '\u2705 Available' : '\u274c Not available'}`,
     `- UI Automation Tools: ${diagnosticInfo.features.idb.uiAutomationSupported ? '\u2705 Available' : '\u274c Not available'}`,
 
+    `\n### Sentry`,
+    `- Sentry enabled: ${diagnosticInfo.environmentVariables.SENTRY_DISABLED !== 'true' ? '✅ Yes' : '❌ No'}`,
+
     `\n## Troubleshooting Tips`,
     `- If UI automation tools are not available, install idb: \`pip3 install fb-idb\``,
     `- For mise integration, follow instructions in the README.md file`,

src/utils/logger.ts

@@ -19,6 +19,8 @@
 
 import * as Sentry from '@sentry/node';
 
+const SENTRY_DISABLED = process.env.SENTRY_DISABLED === 'true';
+
 /**
  * Log a message with the specified level
  * @param level The log level (info, warning, error, debug)
@@ -29,8 +31,8 @@ export function log(level: string, message: string, context?: Record<string, unk
   const timestamp = new Date().toISOString();
   console.error(`[${timestamp}] [${level.toUpperCase()}] ${message}`);
 
-  // Send error logs to Sentry
-  if (level.toLowerCase() === 'error') {
+  // Send error logs to Sentry unless disabled
+  if (!SENTRY_DISABLED && level.toLowerCase() === 'error') {
     Sentry.captureMessage(message, {
       level: 'error',
       extra: context,

src/instrument.ts src/utils/sentry.tssrc/instrument.ts renamed to src/utils/sentry.ts

@@ -6,7 +6,7 @@
  */
 
 import * as Sentry from '@sentry/node';
-import { version } from './version.js';
+import { version } from '../version.js';
 
 Sentry.init({
   dsn: 'https://798607831167c7b9fe2f2912f5d3c665@o4509258288332800.ingest.de.sentry.io/4509258293837904',