JinDaGe - mcp-systemd-coredump MCP Details

article

README

🚀 systemd-coredump MCP 服务器

这是一个 Model Context Protocol (MCP) 服务器，用于与 systemd-coredump 交互。该工具允许支持 MCP 的应用程序管理核心转储文件。

🚀 快速开始

这是一个用于与 systemd-coredump 交互的 Model Context Protocol (MCP) 服务器，支持 MCP 的应用程序可借助它管理核心转储文件。

✨ 主要特性

该服务器提供以下功能：

列出所有可用的核心转储。
获取特定核心转储的详细信息。
提取核心转储文件。
移除核心转储。

📦 安装指南

先决条件

要使用此服务器，您需要满足以下要求：

安装 Node.js（推荐版本：14.x 或更高）。
安装 systemd-coredump 并确保其正常运行。
确保系统上存在 coredumpctl 命令。

安装方式

从 npm 安装

您可以使用以下命令全局安装或本地安装该服务器：

全局安装：

npm install -g systemd-coredump

本地安装：

npm install systemd-coredump

从源码安装

克隆仓库：

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

安装依赖项：

npm install

📚 详细文档

配置

要在 MCP 设置文件中添加此服务器，请参考以下配置：

示例（全局安装）

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

示例（本地安装）

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

使用方法

工具说明

以下是服务器提供的工具及其功能：

list_coredumps
- 列出所有可用的核心转储。
- 示例命令：

mcp list_coredumps

get_coredump_info
- 获取特定核心转储的详细信息。
- 示例命令：

mcp get_coredump_info --id <timestamp>-<pid>

extract_coredump
- 提取核心转储文件到指定路径。
- 示例命令：

mcp extract_coredump --id <timestamp>-<pid> --output ./output/coredump.<timestamp>.dmp

remove_coredump
- 移除特定的核心转储。
- 示例命令：

mcp remove_coredump --id <timestamp>-<pid>

资源说明

服务器暴露以下资源：

核心转储信息
- URI 格式：coredump:///<id>
- 返回 JSON 格式的详细核心转储信息。
堆栈跟踪
- URI 格式：stacktrace:///<id>
- 返回格式化的堆栈跟踪信息。

示例 URI：

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

注意事项

⚠️ 重要提示

某些操作（如提取或移除核心转储）可能需要管理员权限。请确保运行 MCP 服务器的用户具有适当的权限。

📄 许可证

本项目采用 MIT 许可证。

mcp-systemd-coredump