Huntress API MCP Server

Huntress API MCP Server

site icon
2024.12.27 0
JavaScript账户管理组织管理代理管理报告生成金融服务
Huntress API MCP Server 是一个基于模型上下文协议(MCP)的服务器,提供与Huntress API交互的工具。该服务器支持程序化访问Huntress功能,包括账户管理、组织管理、代理管理、事件报告等。
View on GitHub

Overview

基本能力

产品定位

Huntress API MCP Server 是一个基于模型上下文协议(MCP)的服务器,提供与Huntress API交互的工具。

核心功能

  • 账户信息检索
  • 组织管理
  • 代理管理和监控
  • 事件报告访问
  • 摘要报告生成
  • 账单报告访问
  • 内置速率限制(每分钟60个请求)
  • 错误处理和响应格式化

适用场景

  • 需要自动化管理Huntress账户的场景
  • 需要批量处理组织、代理或报告的场景
  • 需要集成Huntress功能到其他系统的场景

工具列表

Account Management

  • get_account_info: 获取当前账户信息

Organization Management

  • list_organizations: 列出账户中的组织
  • get_organization: 获取特定组织的详细信息

Agent Management

  • list_agents: 列出账户中的代理
  • get_agent: 获取特定代理的详细信息

Incident Reports

  • list_incident_reports: 列出事件报告
  • get_incident_report: 获取特定事件报告的详细信息

Summary Reports

  • list_summary_reports: 列出摘要报告
  • get_summary_report: 获取特定摘要报告的详细信息

Billing Reports

  • list_billing_reports: 列出账单报告
  • get_billing_report: 获取特定账单报告的详细信息

常见问题解答

  • 如何获取API凭证? 可以从Huntress账户的API凭证部分获取HUNTRESS_API_KEYHUNTRESS_API_SECRET
  • 速率限制是多少? 服务器实现了Huntress API的速率限制,每分钟最多60个请求。
  • 如何处理错误? 服务器会处理各种错误场景,包括无效API凭证、速率限制超出、无效请求参数和API响应错误。

使用教程

使用依赖

  1. 确保已安装Node.js和npm。

安装教程

  1. 克隆仓库
  2. 安装依赖:
npm install
  1. 基于.env.example创建.env文件:
HUNTRESS_API_KEY=your_api_key_here
HUNTRESS_API_SECRET=your_api_secret_here
  1. 构建服务器:
npm run build

调试方式

  1. 确保.env文件中的API凭证正确。
  2. 使用以下命令启动服务器:
node path/to/huntress-server/build/index.js
  1. 检查控制台输出是否有错误信息。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。