scout_apm_mcp

Ruby gem providing ScoutAPM API client and MCP (Model Context Protocol) server tools for fetching traces, endpoints, metrics, errors, and insights. Integrates with MCP-compatible clients like Cursor IDE, Claude Desktop, and other MCP-enabled tools.

Sponsored by Kisko Labs.

Requirements

• Ruby 3.1 or higher (Ruby 3.0 and earlier are not supported)

Quick Start

1. In scoutapm create API key under Organization settings: https://scoutapm.com/settings
2. In 1Password create an item with the name "Scout APM API" and store the API key in a new field named API_KEY
3. Configure your favorite service to use local MCP server, ensure OP_ENV_ENTRY_PATH has correct vault and item names (both are visible in 1Password UI)

Installation

gem install scout_apm_mcp

Cursor IDE Configuration

For Cursor IDE, create or update .cursor/mcp.json in your project:

{
  "mcpServers": {
    "scout-apm": {
      "command": "gem",
      "args": ["exec", "scout_apm_mcp"],
      "env": {
        "OP_ENV_ENTRY_PATH": "op://Vault Name/Item Name",
        "RUBY_VERSION": "3.4.7"
      }
    }
  }
}

Note: Using gem exec ensures the correct Ruby version is used. If you're using a Ruby version manager like mise or rbenv, set the RUBY_VERSION environment variable to match your desired Ruby version. The gem exec command will automatically use the correct Ruby version based on your version manager configuration.

Claude Desktop Configuration

For Claude Desktop, edit the MCP configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "scout-apm": {
      "command": "gem",
      "args": ["exec", "scout_apm_mcp"],
      "env": {
        "OP_ENV_ENTRY_PATH": "op://Vault Name/Item Name",
        "RUBY_VERSION": "3.4.7"
      }
    }
  }
}

Note: After updating the configuration, restart Claude Desktop for changes to take effect. Using gem exec ensures the correct Ruby version is used. If you're using a Ruby version manager like mise or rbenv, set the RUBY_VERSION environment variable to match your desired Ruby version. The gem exec command will automatically use the correct Ruby version based on your version manager configuration.

Security Best Practice

Do not store API keys or tokens in MCP configuration files. Instead, use one of these methods:

1. 1Password Integration: Set OP_ENV_ENTRY_PATH environment variable (e.g., op://Vault/Item) to automatically load credentials via opdotenv
2. 1Password CLI: The gem will automatically fall back to 1Password CLI if opdotenv is not available
3. Environment Variables: Set API_KEY or SCOUT_APM_API_KEY in your shell environment (not recommended for production - use secret vault for in-memory provisioning)

The gem will automatically detect and use credentials from your environment or 1Password integration.

Testing with MCP Inspector

You can test the MCP server using the MCP Inspector tool:

# Set your 1Password entry path (or use API_KEY/SCOUT_APM_API_KEY)
export OP_ENV_ENTRY_PATH="op://Vault/Scout APM"

# Run the MCP inspector with the server
npx @mo

... [View full README on GitHub](https://github.com/amkisko/scout_apm_mcp.rb#readme)