Show the current LogMCP server configuration and highlight optional parameters that are at their default value.

When to use

Use to understand how this server is configured — which logs are accessible, whether proxy mode or fail2ban are active, which tools are enabled, and which optional features are not yet configured. See logmcp://docs/config for the full configuration reference.

Response

Object with two fields:

• current — key configuration values currently active on this server

• defaults — optional parameters that are at their default value, each with a short explanation of what they do

Run a set of server-side environment checks and return their pass/fail status. Covers configuration validity, TLS setup, log file whitelist, syslog connectivity, and database connectivity.

When to use

Use to verify that the LogMCP server is configured correctly and that all configured backends are reachable. Useful when diagnosing why a tool is not working as expected, or after a configuration change.

Response

Array of check result objects, each with:

• name — check identifier (e.g. config, tls, whitelist, syslog)

• ok — true if the check passed, false if it failed

• detail — human-readable description of the result or error (omitted when empty)

List all log files the server has been configured to expose. Returns an array of file entries ordered by path.

When to use

Call this first to discover which log files are available before calling read_log, search_log, or log_info. If you do not know the exact path of a log file, always call list_logs first.

Response

Array of objects, each with:

• path — absolute path on the server

• size_bytes — file size in bytes

• last_modified — last-modified timestamp (RFC3339)

• line_count — total number of lines

• readable — whether the file is accessible by the server process

Return metadata for a single log file: size, line count, and last-modified timestamp.

When to use

Use to check whether a log file has changed recently, or to determine its total size and line count before deciding how many lines to read with read_log.

Parameters

path

Absolute path to the log file. Obtain valid paths from list_logs.

Response

• path — file path

• size_bytes — file size in bytes

• line_count — total number of lines in the file

• last_modified — last-modified timestamp (RFC3339)

• readable — whether the file is accessible by the server process

Read lines from a log file. Supports reading from the beginning or end, with optional time-based filtering.

When to use

Use to inspect a specific portion of a log file. Use tail: true for the most recent entries. Use since/until to narrow to a specific time window. For targeted pattern matching, prefer search_log instead.

Parameters

path

Absolute path to the log file. Obtain valid paths from list_logs.

lines

Number of lines to return. Defaults to 100.

tail

If true, return the last N lines instead of the first N. Useful for checking recent log activity. Default: false.

offset

Skip this many lines from the start (or from the end if tail=true). Use for pagination through large files.

since

Return only lines after this point in time. Accepts RFC3339 timestamps (2024-01-15T10:00:00Z) or relative durations (1h, 30m, 2h30m). Relative durations are resolved against the current server time.

until

Return only lines before this point in time. Same format as since.

Response

• path — file path that was read

• lines — array of log lines (strings)

• count — number of lines returned

Search a log file for lines matching a regular expression. Returns matching lines with optional surrounding context.

When to use

Use when you need to find specific events, errors, or patterns in a log file without reading the whole file. More efficient than read_log for targeted searches. Combine with since/until to scope the search to a time window.

Parameters

path

Absolute path to the log file. Obtain valid paths from list_logs.

pattern

Regular expression to search for. Uses Go regexp syntax. The pattern is not echoed back in the response.

since

Restrict the search to lines after this point in time. Accepts RFC3339 timestamps or relative durations (1h, 30m).

until

Restrict the search to lines before this point in time. Same format as since.

max_results

Maximum number of matching lines to return. Default: 200.

context_lines

Number of surrounding lines to include before and after each match. Default: 0 (match lines only).

Response

• path — file path that was searched

• pattern_redacted — always "<redacted>" (the search pattern is not echoed back for security reasons)

• matches — array of match objects, each with:

  • line — the matching log line

  • line_number — 1-based line number in the file

  • context_before / context_after — surrounding lines (only present if context_lines > 0)

• count — total number of matches returned

Report the runtime status of this LogMCP server: whether the MCP layer is responding, how many tools are registered, and whether each configured extension is accessible.

When to use

Use as a first step when diagnosing MCP connectivity issues — before the deeper check_environment checks (file system, systemd, TLS). Returns quickly and confirms that the MCP tool layer itself is functional.

Response

ok — true if all checks passed.

checks — array of check result objects, each with:

• name — check identifier

• ok — true if the check passed, false if it failed

• detail — human-readable description of the result or error (omitted when empty)