Skip to main content

MCP server for inspecting log files in XDG_RUNTIME_DIR/log

Project description

Log MCP Server

A Model Context Protocol (MCP) server that enables AI assistants to intelligently inspect and analyze runtime log files for debugging and troubleshooting.

What is this?

This MCP server bridges the gap between your application logs and AI assistants like Claude. When you encounter errors or unexpected behavior in your code, the AI can automatically inspect your runtime logs to diagnose the problem - no more copying and pasting log files back and forth!

The workflow:

  1. Your applications write logs to a configured directory (e.g., $XDG_RUNTIME_DIR/log or custom paths)
  2. This MCP server gives your AI assistant read access to those logs
  3. When you report a problem, the AI proactively checks the logs to find the root cause
  4. Get faster, more accurate debugging assistance based on actual runtime data

Use Cases

  • Development debugging: AI analyzes application logs when tests fail or errors occur
  • Service monitoring: Quickly diagnose issues with background services and daemons
  • Multi-project debugging: Monitor logs from multiple applications simultaneously
  • Learning & training: Understand what your code is doing at runtime by having AI explain the logs

Features

  • Multiple Directory Support: Monitor logs from multiple directories simultaneously
  • Automatic AI Guidance: When activated, the AI is informed about log inspection capabilities and will proactively check logs when users report errors
  • list_log_files: Lists all log files across all configured directories
  • get_log_content: Reads and returns the content of a specific log file
  • read_log_paginated: Read large files in chunks with line numbers
  • search_log_file: Regex search with context lines and pagination
  • runtime-logs prompt: Provides context to the AI about when and how to use log inspection

Installation

From source (development)

git clone <repository-url>
cd log-mcp
pip install -e .

From PyPI (when published)

pip install log-inspector-mcp

Usage

With Claude Desktop

Add to your Claude Desktop config (~/.config/claude/claude_desktop_config.json):

Default directory ($XDG_RUNTIME_DIR/log):

{
  "mcpServers": {
    "log-inspector": {
      "command": "log-mcp"
    }
  }
}

Single custom directory:

{
  "mcpServers": {
    "log-inspector": {
      "command": "log-mcp",
      "args": ["--log-dir", "/var/log"]
    }
  }
}

Multiple directories:

{
  "mcpServers": {
    "log-inspector": {
      "command": "log-mcp",
      "args": [
        "--log-dir", "/var/log",
        "--log-dir", "/tmp/logs",
        "--log-dir", "$XDG_RUNTIME_DIR/log"
      ]
    }
  }
}

Using environment variable (colon-separated):

{
  "mcpServers": {
    "log-inspector": {
      "command": "log-mcp",
      "env": {
        "LOG_MCP_DIR": "/var/log:/tmp/logs:$XDG_RUNTIME_DIR/log"
      }
    }
  }
}

Or using uvx (recommended):

{
  "mcpServers": {
    "log-inspector": {
      "command": "uvx",
      "args": ["log-mcp", "--log-dir", "/var/log"]
    }
  }
}

Standalone

# Use default directory
log-mcp

# Use single custom directory
log-mcp --log-dir /var/log

# Use multiple directories
log-mcp --log-dir /var/log --log-dir /tmp/logs

# Use environment variable (colon-separated)
LOG_MCP_DIR=/var/log:/tmp/logs log-mcp

# See all options
log-mcp --help

Log Directory Priority

The server determines log directories in this order (highest priority first):

  1. --log-dir command-line arguments (can be specified multiple times)
  2. LOG_MCP_DIR environment variable (colon-separated paths, like PATH)
  3. $XDG_RUNTIME_DIR/log (default)

Multiple Directories

When multiple directories are configured:

  • list_log_files scans all directories and returns all found files
  • Other tools accept either:
    • Just the filename (searches all directories for the file)
    • Full absolute path (must be within one of the allowed directories)

How It Works

When the MCP server connects to Claude, it automatically informs the AI that:

  • Runtime logs are available for inspection
  • These logs should be checked whenever users report errors or problems
  • The logs contain valuable diagnostic information for troubleshooting

The AI will proactively use the log inspection tools when appropriate.

Tools

list_log_files

Lists all log files found in $XDG_RUNTIME_DIR/log.

Parameters: None

Returns: List of full paths to all log files found

When to use: First step when investigating any error or problem

get_log_content

Reads and returns the complete content of a specific log file.

Parameters:

  • filename (string, required): Name of the log file to read

Returns: The full content of the specified log file

When to use: For small log files; for large files, use read_log_paginated instead

read_log_paginated

Reads a specific portion of a log file with pagination support.

Parameters:

  • filename (string, required): Name of the log file to read
  • start_line (integer, optional): Starting line number (1-based, default: 1)
  • num_lines (integer, optional): Number of lines to read (default: 100, max: 1000)

Returns: Specified range of lines with line numbers

When to use: For large log files where you need to read specific sections

Example: Read lines 1000-1100 from a large log file

search_log_file

Searches a log file using regex patterns and returns matching lines with surrounding context.

Parameters:

  • filename (string, required): Name of the log file to search
  • pattern (string, required): Regex pattern to search for
  • context_lines (integer, optional): Lines to show before/after each match (default: 2, max: 10)
  • case_sensitive (boolean, optional): Case-sensitive search (default: false)
  • max_matches (integer, optional): Maximum matches to return (default: 50, max: 500)
  • skip_matches (integer, optional): Number of matches to skip for pagination (default: 0)

Returns: Matching lines with context, marked with >>> for the match line

When to use: Searching for specific errors, patterns, or events in log files

Example: Search for all "ERROR" entries with 3 lines of context

Prompts

runtime-logs

A prompt that explains to the AI how and when to use log inspection capabilities. This is automatically available when the server connects.

Example Workflow

  1. Configure your application to log to $XDG_RUNTIME_DIR/log/myapp.log
  2. Add log-mcp to Claude Desktop config
  3. Run your application - it writes logs as it runs
  4. Ask Claude for help: "My application is crashing when I click the submit button"
  5. Claude automatically:
    • Calls list_log_files to see available logs
    • Calls search_log_file to find error messages
    • Analyzes the error context
    • Provides a solution based on the actual error

No more manual log copy-pasting! The AI has direct, intelligent access to your runtime diagnostics.

Configuring Your Applications to Log

For the AI to help debug your applications, they need to write logs to a directory the MCP server monitors. Here are common configuration patterns:

Default Location: $XDG_RUNTIME_DIR/log

On most Linux systems, $XDG_RUNTIME_DIR is /run/user/<UID> (e.g., /run/user/1000). Create the log directory:

mkdir -p $XDG_RUNTIME_DIR/log

Application-Specific Configuration

Node.js / JavaScript

Using Winston:

const winston = require('winston');

const logger = winston.createLogger({
  transports: [
    new winston.transports.File({
      filename: `${process.env.XDG_RUNTIME_DIR}/log/myapp.log`
    })
  ]
});

Using Pino:

const pino = require('pino');
const logger = pino(
  pino.destination(`${process.env.XDG_RUNTIME_DIR}/log/myapp.log`)
);

Python

Using logging module:

import logging
import os

log_dir = os.path.join(os.environ.get('XDG_RUNTIME_DIR', '/tmp'), 'log')
os.makedirs(log_dir, exist_ok=True)

logging.basicConfig(
    filename=os.path.join(log_dir, 'myapp.log'),
    level=logging.DEBUG,
    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
)

Java / Spring Boot

application.properties:

logging.file.path=${XDG_RUNTIME_DIR}/log
logging.file.name=${XDG_RUNTIME_DIR}/log/myapp.log

Rust

Using env_logger:

use std::env;
use std::fs::File;

fn setup_logging() {
    let runtime_dir = env::var("XDG_RUNTIME_DIR").unwrap_or("/tmp".to_string());
    let log_file = format!("{}/log/myapp.log", runtime_dir);

    // Configure your logger to write to log_file
}

Go

package main

import (
    "log"
    "os"
    "path/filepath"
)

func main() {
    runtimeDir := os.Getenv("XDG_RUNTIME_DIR")
    if runtimeDir == "" {
        runtimeDir = "/tmp"
    }

    logPath := filepath.Join(runtimeDir, "log", "myapp.log")
    f, err := os.OpenFile(logPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
    if err != nil {
        log.Fatal(err)
    }
    log.SetOutput(f)
}

IDE Configuration

VSCode (for tasks/debugging)

Create .vscode/tasks.json:

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run with logging",
      "type": "shell",
      "command": "node app.js > $XDG_RUNTIME_DIR/log/myapp.log 2>&1"
    }
  ]
}

IntelliJ IDEA / PyCharm

  1. Edit Run Configuration
  2. Add VM options or Environment Variables:
    • Set log file path to $XDG_RUNTIME_DIR/log/myapp.log
  3. Or modify logging configuration file (logback.xml, log4j.properties, etc.)

Multiple Log Directories

You can monitor logs from different locations simultaneously:

# System logs + application logs + test logs
log-mcp --log-dir /var/log \
        --log-dir $XDG_RUNTIME_DIR/log \
        --log-dir $HOME/projects/myapp/logs

Or use the environment variable:

export LOG_MCP_DIR="/var/log:$XDG_RUNTIME_DIR/log:$HOME/projects/myapp/logs"

Requirements

  • Python 3.10+
  • MCP SDK
  • $XDG_RUNTIME_DIR environment variable (or specify custom directories)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

log_inspector_mcp-0.2.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

log_inspector_mcp-0.2.1-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file log_inspector_mcp-0.2.1.tar.gz.

File metadata

  • Download URL: log_inspector_mcp-0.2.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for log_inspector_mcp-0.2.1.tar.gz
Algorithm Hash digest
SHA256 d661de39d389cf6ba4669f981fcbf762feed6d4ae6081d04a63f8370c911820a
MD5 fab07d1b3f314b526d1a6c170cd0f123
BLAKE2b-256 1b151a122108794ea2124a85dc4b4cb935e1c5a19de2b891cf5b88767d802e1d

See more details on using hashes here.

File details

Details for the file log_inspector_mcp-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for log_inspector_mcp-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c97951fc9a61e283cbd770a6ec34afc43457af6b01255ef66fc5db8962e407bb
MD5 8db43ff9601bd55c7c31ff0b1d1ad244
BLAKE2b-256 d9e6638759d1e5df4b7a1b8162b6b31885e7c8392fd7612699c46ddb0a07cd06

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page