Seq MCP Server 使用说明

项目简介

Seq MCP Server 是一个 Model Context Protocol (MCP) 服务器,专为 Seq 日志和监控系统设计。它充当 LLM(大型语言模型)客户端与 Seq 系统之间的桥梁,使得 LLM 能够安全、便捷地获取 Seq 中存储的日志数据、信号配置以及告警状态等信息。通过 MCP 协议,LLM 可以调用 Seq MCP Server 提供的工具,实现对 Seq 数据的查询和分析,从而增强 LLM 在日志分析、问题排查和系统监控等方面的能力。

主要功能点

  • 资源 (Resources):
    • 信号列表 (signals): 提供 Seq 中共享信号的列表,包含信号的 ID、标题、描述、共享状态和所有者信息,LLM 可以利用这些信号作为后续查询事件的过滤器。
  • 工具 (Tools):
    • 获取信号 (get-signals): 允许 LLM 根据所有者 ID、共享状态和部分匹配等条件,灵活检索 Seq 中配置的信号。
    • 获取事件 (get-events): 支持 LLM 根据信号、过滤器表达式、时间范围(预设或自定义日期范围)等多种条件,从 Seq 中检索日志事件。可以设定返回事件的最大数量。
    • 获取告警状态 (get-alertstate): 允许 LLM 获取 Seq 中当前告警的最新状态。

安装步骤

  1. 克隆仓库: 在本地环境中克隆 Seq MCP Server 仓库:
    git clone https://github.com/ahmad2x4/mcp-server-seq.git
    cd mcp-server-seq
  2. 安装依赖: 使用 npm 安装项目依赖:
    npm install
  3. 构建项目: 构建服务器代码:
    npm run build

服务器配置 (MCP 客户端配置)

为了让 MCP 客户端(例如 Claude Desktop)连接到 Seq MCP Server,您需要在客户端的配置文件中添加服务器配置信息。以下是 Claude Desktop 的 'claude_desktop_config.json' 配置文件示例,展示了如何配置 Seq MCP Server。请注意,您需要将 'your-seq-url' 和 'your-api-key' 替换为您的 Seq 服务器的实际 URL 和 API 密钥。

{
  "mcpServers": {
    "seq": {
      "command": "node",
      "args": ["/path/to/mcp-server-seq/build/seq-server.js"],
      "env": {
        "SEQ_BASE_URL": "your-seq-url",  // Seq 服务器的 URL,例如 "http://localhost:8080" 或您的 Seq 服务器地址
        "SEQ_API_KEY": "your-api-key"    // 您的 Seq API 密钥
      }
    }
  }
}

配置参数说明:

  • '"seq"': 服务器名称,您可以自定义,用于在 MCP 客户端中标识该服务器。
  • '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件。
  • '"args": ["/path/to/mcp-server-seq/build/seq-server.js"]': 命令参数,指向构建后的 'seq-server.js' 文件路径。请将 '/path/to/mcp-server-seq' 替换为您本地仓库的实际路径。
  • '"env"': 环境变量配置。
    • '"SEQ_BASE_URL"': 必填。Seq 服务器的根 URL。如果 Seq 服务器运行在非默认端口或使用了自定义域名,请务必正确配置。
    • '"SEQ_API_KEY"': 必填。用于访问 Seq API 的密钥。您需要在 Seq 服务器中生成 API 密钥并配置在此处。

Claude Desktop 配置文件路径:

  • MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

基本使用方法

  1. 启动 Seq MCP Server: 当 MCP 客户端(如 Claude Desktop)启动并加载配置后,Seq MCP Server 会自动通过 stdio 管道与客户端建立连接。无需手动启动服务器,客户端会根据配置自动启动。
  2. 在 LLM 中使用工具和资源: 在支持 MCP 协议的 LLM 应用中,您可以指示 LLM 使用 Seq MCP Server 提供的工具和资源。例如,您可以要求 LLM "使用 'get-events' 工具查询最近一小时的错误日志事件" 或 "列出所有可用的信号列表"。LLM 将通过 MCP 协议与 Seq MCP Server 通信,调用相应的工具或获取资源,并将结果返回给您。

注意: 首次使用或配置变更后,可能需要重启 MCP 客户端才能使配置生效。

信息

分类

开发者工具