Skip to content

README.md

Latest commit

 

History

History
216 lines (157 loc) · 11.2 KB

README.md

File metadata and controls

216 lines (157 loc) · 11.2 KB

Apex Log MCP Server

npm version CI License Node.js TypeScript

An MCP server that gives AI assistants tools to analyze Salesforce Apex debug logs for performance bottlenecks, slow methods, and governor limit usage.

Claude analyzing an Apex debug log for performance bottlenecks and governor limit concerns

Give your AI assistant — Claude, Copilot, or any MCP-compatible client — the ability to parse Apex debug logs and surface the performance insights that matter. Instead of scrolling through thousands of log lines, ask your assistant to find what's slow and why.

Quick Start | What You Can Do | Tools Reference | Configuration | How It Works | Documentation | Contributing | Contributors | License

Quick Start

Add to your MCP client configuration (claude_desktop_config.json, VS Code mcp.json, etc.):

{
  "mcpServers": {
    "apex-log-mcp": {
      "command": "npx",
      "args": ["-y", "@certinia/apex-log-mcp"]
    }
  }
}

That's it. Open a conversation and ask your AI assistant to analyze an Apex debug log.

What You Can Do

Ask your AI assistant to work with Apex debug logs using natural language:

  • "Give me a summary of this debug log"
  • "Show me the 5 slowest methods in the default namespace"
  • "Are we approaching any governor limits in this transaction?"
  • "Run this Apex against my scratch org and analyze the performance"

Tools Reference

analyze_apex_log_performance

Rank methods in an Apex debug log by self-execution time. Returns method names, durations (in ms), SOQL/DML counts, and optimization recommendations. Best for finding which specific methods to optimize.

Parameter Type Required Description
logFilePath string Yes Absolute path to the Apex debug log file (.log)
topMethods number No Number of slowest methods to return (default: 10)
minDuration number No Minimum duration in milliseconds to include a method (default: 0)
namespace string No Filter methods by namespace

get_apex_log_summary

Get a high-level summary of an Apex debug log including total execution time (in ms), method count, SOQL/DML totals, governor limits, and active namespaces. Best for a quick overview before deeper analysis.

Parameter Type Required Description
logFilePath string Yes Absolute path to the Apex debug log file (.log)

find_performance_bottlenecks

Check whether an Apex log transaction is approaching governor limits (flags usage above 80%). Analyzes CPU time, SOQL/DML limits, query rows, and method execution patterns by namespace. Best for checking if a transaction is at risk of hitting governor limits.

Parameter Type Required Description
logFilePath string Yes Absolute path to the Apex debug log file (.log)
analysisType string No Type of analysis (default: all). See values below.

analysisType values:

Value Description
cpu Checks CPU time governor limit
database Checks SOQL query, DML statement, and query row limits
methods Groups methods by namespace with duration totals
all Runs all three analysis types (default)

execute_anonymous

Executes anonymous Apex code against any authenticated Salesforce org. Saves the resulting debug log to a local file and returns a summary with the file path. Use the file path with get_apex_log_summary, analyze_apex_log_performance, or find_performance_bottlenecks for deeper analysis.

Parameter Type Required Description
apex string Yes The anonymous Apex to be executed
targetOrg string No Alias or username of the target Salesforce org. Uses the project default if not specified.
outputDir string No Directory to save the debug log file. Defaults to .apex-log-mcp/ in the project root.
debugLevel string | object No Controls the trace flag debug levels. Use "default" to reset all categories to defaults, a log level string (e.g. "FINEST") to set all categories to that level, or an object to override specific categories. Omit to keep existing config.

debugLevel as an object — override specific categories, the rest keep their defaults:

{ "database": "FINEST", "apexCode": "FINE" }

Each category accepts a log level: NONE, ERROR, WARN, INFO, DEBUG, FINE, FINER, FINEST

Default debug levels (used when debugLevel is omitted):

Category Default Level
apexCode FINE
apexProfiling FINE
callout DEBUG
database FINEST
nba INFO
system DEBUG
validation DEBUG
visualforce FINE
wave INFO
workflow FINE

Example prompts:

  • "Execute this Apex and show me the log: System.debug('Hello');"
  • "Run a query for all Accounts and analyze the performance"
  • "Execute this Apex with all debug levels set to FINEST"
  • "Run this Apex against my QA org with database logging set to FINEST"

Note: Requires --allowed-orgs to be configured. Uses the project's default org unless targetOrg is specified. The debug log is saved to a local file (default: .apex-log-mcp/) and the response includes the file path, org username (and alias, if set), and execution summary. Add .apex-log-mcp/ to your .gitignore to avoid committing debug logs.

Configuration

The Quick Start configuration is all you need for log analysis tools. The sections below cover enabling execute_anonymous.

Enabling execute_anonymous

The execute_anonymous tool is disabled by default. To enable it, pass --allowed-orgs with a comma-separated list of allowed orgs:

{
  "mcpServers": {
    "apex-log-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@certinia/apex-log-mcp",
        "--allowed-orgs",
        "ALLOW_ALL_ORGS"
      ]
    }
  }
}

Allowed org tokens

Token Description
ALLOW_ALL_ORGS Permits execution against any authenticated org
DEFAULT_TARGET_ORG Resolves the project/global default target-org from Salesforce CLI
DEFAULT_TARGET_DEV_HUB Resolves the project/global default target-dev-hub from Salesforce CLI

You can also pass org usernames or aliases directly:

"args": ["-y", "@certinia/apex-log-mcp", "--allowed-orgs", "dev@example.com,my-scratch-org"]

How It Works

This server implements the Model Context Protocol (MCP) to expose Apex log analysis as tools that any MCP-compatible AI client can call.

  • Runs as a local process — your AI client spawns the server and communicates locally. No network requests, no API keys.
  • Uses the same parser as the Apex Log Analyzer VS Code extension — battle-tested parsing of the Apex debug log format.
  • Returns structured data — all durations in milliseconds, governor limits as used/limit pairs, methods with SOQL/DML counts — so your AI assistant can reason about the results.

Documentation

Related Projects

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Contributors

Thanks to our amazing contributors!

License

Copyright © Certinia Inc. All rights reserved.