article
README
🚀 猎人 API MCP 服务器
本服务器基于 Model Context Protocol (MCP),提供了与 Huntress API 交互的工具。它为账户管理、组织管理、代理管理、事件报告、总结报告等功能提供了编程访问接口,极大地方便了相关操作。
🚀 快速开始
本服务器提供了便捷的编程访问接口,可用于账户管理、组织管理、代理管理等多种功能。下面将为您详细介绍其安装和使用方法。
✨ 主要特性
- 账户信息检索:方便获取当前账户的详细信息。
- 组织管理:支持列出账户中的组织,并获取特定组织的详细信息。
- 代理管理与监控:可对账户中的代理进行管理和监控。
- 事件报告访问:能够列出和获取特定的事件报告。
- 总结报告生成:支持生成总结报告。
- 费用报告访问:可访问费用报告。
- 内置速率限制:每分钟限制 60 次请求,确保系统稳定。
- 错误处理和响应格式化:对多种错误场景进行处理,并格式化响应信息。
📦 安装指南
通过 Smithery 安装
若要通过 Smithery 自动安装 Huntress API MCP 服务器以供 Claude Desktop 使用,可执行以下命令:
npx -y @smithery/cli install huntress-mcp-server --client claude
手动安装
- 克隆仓库。
- 安装依赖项:
npm install
- 基于
.env.example创建一个.env文件:
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
高级用法
配置
服务器需要以下环境变量:
HUNTRESS_API_KEY:您的 Huntress API KeyHUNTRESS_API_SECRET:您的 Huntress API Secret Key
这些可以在您的 Huntress 账户的 <your_account_subdomain>.huntress.io 下的“API凭证”部分获取。
与 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 的速率限制,即每分钟 60 次请求的滑动窗口。这意味着:
- 在任何 60 秒的时间段内,最多只能执行 60 次请求。
- 窗口是动态移动的,例如:如果请求 1 发布在 T0,请求 60 发布在 T30,则请求 61 必须等待直到 T60。
错误处理
服务器处理了多种错误场景:
- 无效的 API 凭证。
- 请求超时。
- 网络连接问题。
📄 许可证
[在此处指定许可证信息,如果适用]
此文档为您提供了 Huntress API MCP 服务器的完整功能概述和使用指南。如需进一步帮助或详细信息,请参考相关文档或联系支持团队。
扫码联系在线客服