article
README
🚀 猎人 API MCP 服务器
本项目是一个模型上下文协议(MCP)服务器,它提供了与 Huntress API 交互的工具。借助该服务器,你能够以编程方式访问 Huntress 的各项功能,涵盖账户管理、组织管理、代理管理、事故报告、摘要报告等多个方面。
🚀 快速开始
本服务器可让你通过编程方式访问 Huntress 功能,下面为你介绍使用前的准备工作。
✨ 主要特性
- 🔍 获取账户信息
- 🏢 组织管理
- 🖥️ 代理管理和监控
- 📄 事故报告访问
- 📊 摘要报告生成
- 💰 账单报告访问
- ⏱️ 内置速率限制(每分钟 60 个请求)
- ❌ 错误处理和响应格式化
📦 安装指南
按照以下步骤安装本项目:
- 克隆仓库。
- 安装依赖:
npm install
- 基于
.env.example创建一个.env文件,并填入 API 密钥和机密密钥:
HUNTRESS_API_KEY=your_api_key_here
HUNTRESS_API_SECRET=your_api_secret_here
- 构建服务器:
npm run build
💻 使用示例
可用工具
本服务器提供了一系列工具,用于不同功能的操作:
账户管理
get_account_info:获取当前账户的信息。
组织管理
list_organizations:列出账户中的组织。get_organization:获取特定组织的详细信息。
代理管理
list_agents:列出账户中的代理。get_agent:获取特定代理的详细信息。
事故报告
list_incident_reports:列出事故报告。get_incident_report:获取特定事故报告的详细信息。
摘要报告
list_summary_reports:列出摘要报告。get_summary_report:获取特定摘要报告的详细信息。
账单报告
list_billing_reports:列出账单报告。get_billing_report:获取特定账单报告的详细信息。
使用 MCP
将以下配置添加到您的 MCP 设置中:
{
"mcpServers": {
"huntress": {
"command": "node",
"args": ["path/to/huntress-server/build/index.js"],
"env": {
"HUNTRESS_API_KEY": "your_api_key_here",
"HUNTRESS_API_SECRET": "your_api_secret_here"
}
}
}
}
📚 详细文档
配置
服务器需要以下环境变量:
HUNTRESS_API_KEY:您的 Huntress API 密钥。HUNTRESS_API_SECRET:您的 Huntress API 机密密钥。 这些可以在您 Huntress 账户的<your_account_subdomain>.huntress.io下的 API 凭证部分获取。
速率限制
服务器实现了 Huntress API 的每分钟 60 个请求的速率限制(基于滑动窗口)。具体规则如下:
- 每个 60 秒时间段内最多只能有 60 个请求。
- 窗口会滑动,因此如果第 1 个请求在 T0 提交,第 60 个请求在 T30 提交,则第 61 个请求必须等待直到 T60。
错误处理
服务器处理了多种错误场景:
- ⚠️ 无效的 API 凭证。
- ⚠️ 请求速率限制超过。
- ⚠️ 无效的请求参数。
- ⚠️ API 响应错误。
📄 许可证
本项目采用 MIT 许可证,有关详细信息,请参阅 LICENSE 文件。
微信扫一扫