MCP Systemd Coredump

🚀 systemd-coredump MCP Server

This is a Model Context Protocol (MCP) server designed to interact with systemd-coredump. This tool enables MCP - supported applications to manage core dump files.

Tags

• npm Version:
• License: MIT

✨ Features

The server offers the following features:

1. List all available core dumps.
2. Retrieve detailed information about a specific core dump.
3. Extract core dump files.
4. Remove core dumps.

📦 Installation

Prerequisites

To use this server, you need to meet the following requirements:

• Install Node.js (Recommended version: 14.x or higher).
• Install systemd-coredump and ensure it is running properly.
• Ensure the coredumpctl command exists on the system.

Install from npm

You can install the server globally or locally using the following commands:

Global installation:

npm install -g systemd-coredump

Local installation:

npm install systemd-coredump

Install from source code:

1. Clone the repository:

   git clone https://github.com/yourusername/systemd-coredump.git
   cd systemd-coredump
   

2. Install dependencies:

   npm install
   

📚 Documentation

Configuration

To add this server to the MCP settings file, refer to the following configurations:

Example (Global installation):

{
  "systemd-coredump": {
    "installed": true,
    "path": "/usr/local/bin/coredumpctl"
  }
}

Example (Local installation):

{
  "systemd-coredump": {
    "installed": true,
    "path": "./node_modules/.bin/coredumpctl"
  }
}

💻 Usage Examples

Tool Explanation

The following are the tools provided by the server and their functions:

Basic Usage

# List all available core dumps
mcp list_coredumps

Advanced Usage

# Get detailed information about a specific core dump
mcp get_coredump_info --id <timestamp>-<pid>

# Extract a core dump file to a specified path
mcp extract_coredump --id <timestamp>-<pid> --output ./output/coredump.<timestamp>.dmp

# Remove a specific core dump
mcp remove_coredump --id <timestamp>-<pid>

Resource Explanation

The server exposes the following resources:

1. Core dump information

   • URI format: coredump:///<id>
   • Returns detailed core dump information in JSON format.

2. Stack trace

   • URI format: stacktrace:///<id>
   • Returns formatted stack trace information.

Example URIs:

coredump:///2023-04-20 12:34:56-12345
stacktrace:///2023-04-20 12:34:56-12345

⚠️ Important Note

Certain operations (such as extracting or removing core dumps) may require administrator privileges. Ensure that the user running the MCP server has appropriate permissions.

📄 License

MIT