Salesforce MCP Server

salesforce_manage_debug_logs

Enable, disable, or retrieve debug logs for Salesforce users to monitor and troubleshoot application behavior.

Instructions

Manage debug logs for Salesforce users - enable, disable, or retrieve logs.

Examples:

Enable debug logs for a user: { "operation": "enable", "username": "user@example.com", "logLevel": "DEBUG", "expirationTime": 30 }
Disable debug logs for a user: { "operation": "disable", "username": "user@example.com" }
Retrieve debug logs for a user: { "operation": "retrieve", "username": "user@example.com", "limit": 5 }
Retrieve a specific log with full content: { "operation": "retrieve", "username": "user@example.com", "logId": "07L1g000000XXXXEAA0", "includeBody": true }

Notes:

The operation must be one of: 'enable', 'disable', or 'retrieve'
The username parameter is required for all operations
For 'enable' operation, logLevel is optional (defaults to 'DEBUG')
Log levels: NONE, ERROR, WARN, INFO, DEBUG, FINE, FINER, FINEST
expirationTime is optional for 'enable' operation (minutes until expiration, defaults to 30)
limit is optional for 'retrieve' operation (maximum number of logs to return, defaults to 10)
logId is optional for 'retrieve' operation (to get a specific log)
includeBody is optional for 'retrieve' operation (to include the full log content, defaults to false)
The tool validates that the specified user exists before performing operations
If logLevel is not specified when enabling logs, the tool will ask for clarification

Input Schema

TableJSON Schema

Name	Required	Description
`operation`	Yes	Operation to perform on debug logs
`username`	Yes	Username of the Salesforce user
`logLevel`	No	Log level for debug logs (required for 'enable' operation)
`expirationTime`	No	Minutes until the debug log configuration expires (optional, defaults to 30)
`limit`	No	Maximum number of logs to retrieve (optional, defaults to 10)
`logId`	No	ID of a specific log to retrieve (optional)
`includeBody`	No	Whether to include the full log content (optional, defaults to false)

Implementation Reference

src/tools/manageDebugLogs.ts:103-481 (handler)

The core handler function that executes the tool logic: validates inputs, finds user, and performs enable/disable/retrieve operations on debug logs using Salesforce Tooling API (TraceFlag, DebugLevel, ApexLog).

export async function handleManageDebugLogs(conn: any, args: ManageDebugLogsArgs) {
  try {
    // Validate inputs
    if (!args.username) {
      throw new Error('username is required');
    }
    
    // Determine if the input is likely a username or a full name
    const isLikelyUsername = args.username.includes('@') || !args.username.includes(' ');
    
    // Build the query based on whether the input looks like a username or a full name
    let userQuery;
    if (isLikelyUsername) {
      // Query by username
      userQuery = await conn.query(`
        SELECT Id, Username, Name, IsActive 
        FROM User 
        WHERE Username = '${args.username}'
      `);
    } else {
      // Query by full name
      userQuery = await conn.query(`
        SELECT Id, Username, Name, IsActive 
        FROM User 
        WHERE Name LIKE '%${args.username}%'
        ORDER BY LastModifiedDate DESC
        LIMIT 5
      `);
    }
    
    if (userQuery.records.length === 0) {
      // If no results with the initial query, try a more flexible search
      userQuery = await conn.query(`
        SELECT Id, Username, Name, IsActive 
        FROM User 
        WHERE Name LIKE '%${args.username}%' 
        OR Username LIKE '%${args.username}%'
        ORDER BY LastModifiedDate DESC
        LIMIT 5
      `);
      
      if (userQuery.records.length === 0) {
        return {
          content: [{ 
            type: "text", 
            text: `Error: No user found matching '${args.username}'. Please verify the username or full name and try again.` 
          }],
          isError: true,
        };
      }
      
      // If multiple users found, ask for clarification
      if (userQuery.records.length > 1) {
        let responseText = `Multiple users found matching '${args.username}'. Please specify which user by providing the exact username:\n\n`;
        
        userQuery.records.forEach((user: any) => {
          responseText += `- **${user.Name}** (${user.Username})\n`;
        });
        
        return {
          content: [{ 
            type: "text", 
            text: responseText
          }]
        };
      }
    }
    
    const user = userQuery.records[0];
    
    if (!user.IsActive) {
      return {
        content: [{ 
          type: "text", 
          text: `Warning: User '${args.username}' exists but is inactive. Debug logs may not be generated for inactive users.` 
        }]
      };
    }
    
    // Handle operations
    switch (args.operation) {
      case 'enable': {
        // If logLevel is not provided, we need to ask for it
        if (!args.logLevel) {
          return {
            content: [{ 
              type: "text", 
              text: `Please specify a log level for enabling debug logs. Valid options are: NONE, ERROR, WARN, INFO, DEBUG, FINE, FINER, FINEST.` 
            }],
            isError: true,
          };
        }
        
        // Set default expiration time if not provided
        const expirationTime = args.expirationTime || 30;
        
        // Check if a trace flag already exists for this user
        const existingTraceFlag = await conn.tooling.query(`
          SELECT Id, DebugLevelId FROM TraceFlag 
          WHERE TracedEntityId = '${user.Id}' 
          AND ExpirationDate > ${new Date().toISOString()}
        `);
        
        let traceFlagId;
        let debugLevelId;
        let operation;
        
        // Calculate expiration date
        const expirationDate = new Date();
        expirationDate.setMinutes(expirationDate.getMinutes() + expirationTime);
        
        if (existingTraceFlag.records.length > 0) {
          // Update existing trace flag
          traceFlagId = existingTraceFlag.records[0].Id;
          debugLevelId = existingTraceFlag.records[0].DebugLevelId;
          
          await conn.tooling.sobject('TraceFlag').update({
            Id: traceFlagId,
            LogType: 'USER_DEBUG',
            StartDate: new Date().toISOString(),
            ExpirationDate: expirationDate.toISOString()
          });
          operation = 'updated';
        } else {
          // Create a new debug level with the correct field names
          const debugLevelResult = await conn.tooling.sobject('DebugLevel').create({
            DeveloperName: `UserDebug_${Date.now()}`,
            MasterLabel: `User Debug ${user.Username}`,
            ApexCode: args.logLevel,
            ApexProfiling: args.logLevel,
            Callout: args.logLevel,
            Database: args.logLevel,
            System: args.logLevel,
            Validation: args.logLevel,
            Visualforce: args.logLevel,
            Workflow: args.logLevel
          });
          
          debugLevelId = debugLevelResult.id;
          
          // Create a new trace flag
          const traceFlagResult = await conn.tooling.sobject('TraceFlag').create({
            TracedEntityId: user.Id,
            DebugLevelId: debugLevelId,
            LogType: 'USER_DEBUG',
            StartDate: new Date().toISOString(),
            ExpirationDate: expirationDate.toISOString()
          });
          
          traceFlagId = traceFlagResult.id;
          operation = 'enabled';
        }
        
        return {
          content: [{ 
            type: "text", 
            text: `Successfully ${operation} debug logs for user '${args.username}'.\n\n` +
                  `**Log Level:** ${args.logLevel}\n` +
                  `**Expiration:** ${expirationDate.toLocaleString()} (${expirationTime} minutes from now)\n` +
                  `**Trace Flag ID:** ${traceFlagId}`
          }]
        };
      }
      
      case 'disable': {
        // Find all active trace flags for this user
        const traceFlags = await conn.tooling.query(`
          SELECT Id FROM TraceFlag WHERE TracedEntityId = '${user.Id}' AND ExpirationDate > ${new Date().toISOString()}
        `);
        
        if (traceFlags.records.length === 0) {
          return {
            content: [{ 
              type: "text", 
              text: `No active debug logs found for user '${args.username}'.` 
            }]
          };
        }
        
        try {
          // Delete trace flags instead of updating expiration date
          const traceFlagIds = traceFlags.records.map((tf: any) => tf.Id);
          const deleteResults = await Promise.all(
            traceFlagIds.map((id: string) => 
              conn.tooling.sobject('TraceFlag').delete(id)
            )
          );
          
          return {
            content: [{ 
              type: "text", 
              text: `Successfully disabled ${traceFlagIds.length} debug log configuration(s) for user '${args.username}' by removing them.` 
            }]
          };
        } catch (deleteError) {
          console.error('Error deleting trace flags:', deleteError);
          
          // Fallback to setting a future expiration date if delete fails
          try {
            // Set expiration date to 5 minutes in the future to satisfy Salesforce's requirement
            const nearFutureExpiration = new Date();
            nearFutureExpiration.setMinutes(nearFutureExpiration.getMinutes() + 5);
            
            const traceFlagIds = traceFlags.records.map((tf: any) => tf.Id);
            const updateResults = await Promise.all(
              traceFlagIds.map((id: string) => 
                conn.tooling.sobject('TraceFlag').update({
                  Id: id,
                  ExpirationDate: nearFutureExpiration.toISOString()
                })
              )
            );
            
            return {
              content: [{ 
                type: "text", 
                text: `Successfully disabled ${traceFlagIds.length} debug log configuration(s) for user '${args.username}'. They will expire in 5 minutes.` 
              }]
            };
          } catch (updateError) {
            console.error('Error updating trace flags:', updateError);
            throw new Error(`Could not disable debug logs: ${deleteError instanceof Error ? deleteError.message : String(deleteError)}`);
          }
        }
      }
      
      case 'retrieve': {
        // Set default limit if not provided
        const limit = args.limit || 10;
        
        // If a specific log ID is provided, retrieve that log directly
        if (args.logId) {
          try {
            // First check if the log exists
            const logQuery = await conn.tooling.query(`
              SELECT Id, LogUserId, Operation, Application, Status, LogLength, LastModifiedDate, Request
              FROM ApexLog 
              WHERE Id = '${args.logId}'
            `);
            
            if (logQuery.records.length === 0) {
              return {
                content: [{ 
                  type: "text", 
                  text: `No log found with ID '${args.logId}'.` 
                }]
              };
            }
            
            const log = logQuery.records[0];
            
            // If includeBody is true, retrieve the log body
            if (args.includeBody) {
              try {
                // Retrieve the log body
                const logBody = await conn.tooling.request({
                  method: 'GET',
                  url: `${conn.instanceUrl}/services/data/v58.0/tooling/sobjects/ApexLog/${log.Id}/Body`
                });
                
                let responseText = `**Log Details:**\n\n`;
                responseText += `- **ID:** ${log.Id}\n`;
                responseText += `- **Operation:** ${log.Operation}\n`;
                responseText += `- **Application:** ${log.Application}\n`;
                responseText += `- **Status:** ${log.Status}\n`;
                responseText += `- **Size:** ${log.LogLength} bytes\n`;
                responseText += `- **Date:** ${new Date(log.LastModifiedDate).toLocaleString()}\n\n`;
                responseText += `**Log Body:**\n\`\`\`\n${logBody}\n\`\`\`\n`;
                
                return {
                  content: [{ 
                    type: "text", 
                    text: responseText
                  }]
                };
              } catch (logError) {
                console.error('Error retrieving log body:', logError);
                return {
                  content: [{ 
                    type: "text", 
                    text: `Error retrieving log body: ${logError instanceof Error ? logError.message : String(logError)}` 
                  }],
                  isError: true
                };
              }
            } else {
              // Just return the log metadata
              let responseText = `**Log Details:**\n\n`;
              responseText += `- **ID:** ${log.Id}\n`;
              responseText += `- **Operation:** ${log.Operation}\n`;
              responseText += `- **Application:** ${log.Application}\n`;
              responseText += `- **Status:** ${log.Status}\n`;
              responseText += `- **Size:** ${log.LogLength} bytes\n`;
              responseText += `- **Date:** ${new Date(log.LastModifiedDate).toLocaleString()}\n\n`;
              responseText += `To view the full log content, add "includeBody": true to your request.`;
              
              return {
                content: [{ 
                  type: "text", 
                  text: responseText
                }]
              };
            }
          } catch (error) {
            console.error('Error retrieving log:', error);
            return {
              content: [{ 
                type: "text", 
                text: `Error retrieving log: ${error instanceof Error ? error.message : String(error)}` 
              }],
              isError: true,
            };
          }
        }
        
        // Query for logs
        const logs = await conn.tooling.query(`
          SELECT Id, LogUserId, Operation, Application, Status, LogLength, LastModifiedDate, Request
          FROM ApexLog 
          WHERE LogUserId = '${user.Id}'
          ORDER BY LastModifiedDate DESC 
          LIMIT ${limit}
        `);
        
        if (logs.records.length === 0) {
          return {
            content: [{ 
              type: "text", 
              text: `No debug logs found for user '${args.username}'.` 
            }]
          };
        }
        
        // Format log information
        let responseText = `Found ${logs.records.length} debug logs for user '${args.username}':\n\n`;
        
        for (let i = 0; i < logs.records.length; i++) {
          const log = logs.records[i];
          
          responseText += `**Log ${i + 1}**\n`;
          responseText += `- **ID:** ${log.Id}\n`;
          responseText += `- **Operation:** ${log.Operation}\n`;
          responseText += `- **Application:** ${log.Application}\n`;
          responseText += `- **Status:** ${log.Status}\n`;
          responseText += `- **Size:** ${log.LogLength} bytes\n`;
          responseText += `- **Date:** ${new Date(log.LastModifiedDate).toLocaleString()}\n\n`;
        }
        
        // Add a note about viewing specific logs with full content
        responseText += `To view a specific log with full content, use:\n\`\`\`\n`;
        responseText += `{\n`;
        responseText += `  "operation": "retrieve",\n`;
        responseText += `  "username": "${args.username}",\n`;
        responseText += `  "logId": "<LOG_ID>",\n`;
        responseText += `  "includeBody": true\n`;
        responseText += `}\n\`\`\`\n`;
        
        return {
          content: [{ 
            type: "text", 
            text: responseText
          }]
        };
      }
      
      default:
        throw new Error(`Invalid operation: ${args.operation}. Must be 'enable', 'disable', or 'retrieve'.`);
    }
  } catch (error) {
    console.error('Error managing debug logs:', error);
    return {
      content: [{ 
        type: "text", 
        text: `Error managing debug logs: ${error instanceof Error ? error.message : String(error)}` 
      }],
      isError: true,
    };
  }
}

src/tools/manageDebugLogs.ts:4-85 (schema)

Tool definition including name, description, and complete inputSchema for validation of parameters like operation, username, logLevel, etc.

export const MANAGE_DEBUG_LOGS: Tool = {
  name: "salesforce_manage_debug_logs",
  description: `Manage debug logs for Salesforce users - enable, disable, or retrieve logs.
  
Examples:
1. Enable debug logs for a user:
   {
     "operation": "enable",
     "username": "user@example.com",
     "logLevel": "DEBUG",
     "expirationTime": 30
   }

2. Disable debug logs for a user:
   {
     "operation": "disable",
     "username": "user@example.com"
   }

3. Retrieve debug logs for a user:
   {
     "operation": "retrieve",
     "username": "user@example.com",
     "limit": 5
   }

4. Retrieve a specific log with full content:
   {
     "operation": "retrieve",
     "username": "user@example.com",
     "logId": "07L1g000000XXXXEAA0",
     "includeBody": true
   }

Notes:
- The operation must be one of: 'enable', 'disable', or 'retrieve'
- The username parameter is required for all operations
- For 'enable' operation, logLevel is optional (defaults to 'DEBUG')
- Log levels: NONE, ERROR, WARN, INFO, DEBUG, FINE, FINER, FINEST
- expirationTime is optional for 'enable' operation (minutes until expiration, defaults to 30)
- limit is optional for 'retrieve' operation (maximum number of logs to return, defaults to 10)
- logId is optional for 'retrieve' operation (to get a specific log)
- includeBody is optional for 'retrieve' operation (to include the full log content, defaults to false)
- The tool validates that the specified user exists before performing operations
- If logLevel is not specified when enabling logs, the tool will ask for clarification`,
  inputSchema: {
    type: "object",
    properties: {
      operation: {
        type: "string",
        enum: ["enable", "disable", "retrieve"],
        description: "Operation to perform on debug logs"
      },
      username: {
        type: "string",
        description: "Username of the Salesforce user"
      },
      logLevel: {
        type: "string",
        enum: ["NONE", "ERROR", "WARN", "INFO", "DEBUG", "FINE", "FINER", "FINEST"],
        description: "Log level for debug logs (required for 'enable' operation)"
      },
      expirationTime: {
        type: "number",
        description: "Minutes until the debug log configuration expires (optional, defaults to 30)"
      },
      limit: {
        type: "number",
        description: "Maximum number of logs to retrieve (optional, defaults to 10)"
      },
      logId: {
        type: "string",
        description: "ID of a specific log to retrieve (optional)"
      },
      includeBody: {
        type: "boolean",
        description: "Whether to include the full log content (optional, defaults to false)"
      }
    },
    required: ["operation", "username"]
  }
};

src/index.ts:61-62 (registration)
Registration of the tool in the listToolsRequestHandler, adding MANAGE_DEBUG_LOGS to the available tools list.
```
  MANAGE_DEBUG_LOGS
],
```

src/index.ts:303-321 (registration)

Dispatch registration in the CallToolRequestHandler switch statement, validating arguments and calling the handleManageDebugLogs function.

case "salesforce_manage_debug_logs": {
  const debugLogsArgs = args as Record<string, unknown>;
  if (!debugLogsArgs.operation || !debugLogsArgs.username) {
    throw new Error('operation and username are required for managing debug logs');
  }
  
  // Type check and conversion
  const validatedArgs: ManageDebugLogsArgs = {
    operation: debugLogsArgs.operation as 'enable' | 'disable' | 'retrieve',
    username: debugLogsArgs.username as string,
    logLevel: debugLogsArgs.logLevel as 'NONE' | 'ERROR' | 'WARN' | 'INFO' | 'DEBUG' | 'FINE' | 'FINER' | 'FINEST' | undefined,
    expirationTime: debugLogsArgs.expirationTime as number | undefined,
    limit: debugLogsArgs.limit as number | undefined,
    logId: debugLogsArgs.logId as string | undefined,
    includeBody: debugLogsArgs.includeBody as boolean | undefined
  };

  return await handleManageDebugLogs(conn, validatedArgs);
}

src/tools/manageDebugLogs.ts:87-95 (schema)

TypeScript interface defining the input arguments for the handler function, used for type safety.

export interface ManageDebugLogsArgs {
  operation: 'enable' | 'disable' | 'retrieve';
  username: string;
  logLevel?: 'NONE' | 'ERROR' | 'WARN' | 'INFO' | 'DEBUG' | 'FINE' | 'FINER' | 'FINEST';
  expirationTime?: number;
  limit?: number;
  logId?: string;
  includeBody?: boolean;
}

Tool Definition Quality

A4/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden and delivers substantial behavioral context. It discloses validation behavior ('validates that the specified user exists'), clarification prompts ('will ask for clarification' when logLevel unspecified), default values, and operational constraints. However, it doesn't mention authentication requirements, rate limits, or error response formats.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose statement, examples, notes) and every sentence adds value. While comprehensive, it could be more front-loaded - the detailed examples come before the general notes that would help the agent understand constraints first. No wasted text, but slightly longer than ideal.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 7-parameter tool with no annotations and no output schema, the description provides good operational context but has gaps. It covers parameter usage well but doesn't describe return values, error conditions, or authentication requirements. The examples help, but without output schema, the agent doesn't know what to expect from successful operations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Despite 100% schema description coverage, the description adds significant value through detailed examples showing parameter combinations for different operations, clarification of optional/required status per operation, default values, and operational constraints. The schema provides basic descriptions, but the description adds practical usage context that helps the agent understand how parameters interact.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verbs ('enable, disable, or retrieve logs') and resource ('debug logs for Salesforce users'). It distinguishes itself from sibling tools like salesforce_query_records or salesforce_dml_records by focusing specifically on debug log management rather than general data operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides implied usage through examples showing different operations, but lacks explicit guidance on when to choose this tool versus alternatives. There's no mention of prerequisites, error conditions, or comparison to other debug-related tools that might exist in the Salesforce ecosystem.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

Lightport: Open-Sourcing Glama's AI Gateway
By punkpeye on April 27, 2026.
open source
OpenAI
Tool Definition Quality Score (TDQS)
By punkpeye on April 3, 2026.
mcp
The Hackers Who Tracked My Sleep Cycle
By punkpeye on March 26, 2026.
security

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/simonl77/mcp-server-salesforce'

If you have feedback or need assistance with the MCP directory API, please join our Discord server