项目简介

Huntress API MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务,它提供了一系列工具,使得大型语言模型 (LLM) 能够安全地访问和操作 Huntress 安全平台的功能。通过这个服务器,LLM 可以获取账户信息、管理组织和 Agent、访问安全事件报告等。

主要功能点

  • 获取 Huntress 账户信息
  • 管理 Huntress 组织信息
  • 管理和监控 Huntress Agent
  • 访问 Huntress 安全事件报告
  • 生成 Huntress 汇总报告
  • 访问 Huntress 账单报告
  • 内置速率限制,防止滥用
  • 完善的错误处理和响应格式

安装步骤

  1. 克隆代码仓库到本地
  2. 进入代码仓库目录,安装依赖:
    npm install
  3. 在代码仓库根目录下,创建 '.env' 文件,并根据 '.env.example' 文件的示例,填写您的 Huntress API 密钥 ('HUNTRESS_API_KEY') 和 API Secret ('HUNTRESS_API_SECRET')。这两个密钥可以在您的 Huntress 账户控制面板的 API Credentials 页面找到。
  4. 构建服务器代码:
    npm run build

服务器配置

要将 Huntress MCP 服务器配置到 MCP 客户端,您需要在客户端的配置文件中添加以下 JSON 配置。这个配置告诉 MCP 客户端如何启动和连接到 Huntress MCP 服务器。

{
  "mcpServers": {
    "huntress": {
      "command": "node",
      "args": ["path/to/huntress-server/build/index.js"]
    }
  }
}
  • 'command': 指定启动 MCP 服务器的命令。这里使用 'node' 命令来运行 JavaScript 代码。
  • 'args': 一个字符串数组,包含了传递给 'command' 的参数。'path/to/huntress-server/build/index.js' 需要替换为 Huntress 服务器构建后 'index.js' 文件的实际路径。例如,如果您的 Huntress 服务器代码仓库位于 '/path/to/huntress-server',并且您在仓库根目录下执行了 'npm run build' 命令,那么这个路径通常是 'build/index.js'。

重要: 请确保在运行 MCP 客户端的环境中设置了 'HUNTRESS_API_KEY' 和 'HUNTRESS_API_SECRET' 环境变量。Huntress MCP 服务器会读取这些环境变量来进行 API 身份验证。您可以在 MCP 客户端的启动脚本或者系统环境变量中设置它们。

基本使用方法

配置完成后,MCP 客户端将能够通过标准 MCP 协议与 Huntress MCP 服务器通信。LLM 应用可以通过客户端向 Huntress MCP 服务器发送请求,调用服务器提供的各种工具。例如,可以调用 'list_agents' 工具来获取 Huntress Agent 列表,或者调用 'get_incident_report' 工具来获取特定安全事件的详细报告。

具体的工具列表和每个工具的参数定义,请参考仓库 'README.md' 文件中 "Available Tools" 部分的详细说明。LLM 应用可以根据这些工具描述和参数定义,构造合适的 MCP 请求来利用 Huntress API 的功能。

信息

分类

网页与API