HackTheBox MCP客户端
A. 文本TUI HackTheBox模型上下文协议（MCP）服务器的（终端用户界面）客户端。通过流畅的交互式终端界面浏览CTF事件和挑战、执行工具和管理资源。
✨ 特性
- 🖥️ 丰富的TUI界面 -采用Textual打造现代终端体验
- 🎯 活动和挑战选择 -使用拆分面板视图浏览和选择CTF事件和挑战
- 🔧 工具执行 -使用引导参数输入执行HackTheBox MCP工具
- 📊 数据表 -在有组织的表中查看工具、资源和参数
- 💾 导出功能 -将结果保存为JSON或Markdown文件
- 🎨 黑客主题 -黑上绿美学
- ⚡ 自动填充 -从所选事件/挑战中自动填充工具参数
- 🔄 状态管理 -跨屏幕持续选择
- 📖 资源管理 -阅读和浏览MCP资源
📋 先决条件
- Python 3.10或更高版本
- HackTheBox API访问令牌（JWT）
🚀 安装
1.克隆存储库
git clone https://github.com/therealfredp3d/HTB-MCP-Client.git
cd HTB-MCP-Client2.安装依赖项
使用 pip:
pip install -r requirements.txt或使用 uv 为了更快地安装：
uv pip install -r requirements.txt3.配置您的API令牌
创建一个 .env 模板中的文件：
cp .env.example .env编辑 .env 并添加您的HackTheBox API令牌：
API_ACCESS_TOKEN=your-hackthebox-jwt-token-here小贴士：您可以在中找到您的API令牌 .mcp.json 文件或从您的HackTheBox配置文件设置中生成一个新的文件。💻 用法
运行TUI客户端
python htb_mcp_client.py检查版本
python htb_mcp_client.py --version🎮 TUI接口指南
主菜单
主菜单提供对所有主要功能的快速访问：
- 列出工具 -查看所有可用的MCP工具
- 列出资源 -浏览MCP资源
- 挑战 -访问存储的挑战数据
- 呼叫工具 -使用自定义参数执行工具
- 读取资源 -按URI获取资源
- 退出 -关闭应用程序
导航屏幕
- 方向键 -浏览列表和表格
- 进入 -选择一个项目
- 选项卡 -在UI元素之间移动
- q -退出应用程序（全局绑定）
- d -切换暗模式
活动选择
当您列出CTF事件时：
- 左侧面板显示事件ID和名称
- 右侧面板在Markdown中显示详细的事件信息
- 导航方式↑/↓ 方向键
- 按 进入 或单击“选择事件”以存储事件
- 所选事件出现在主菜单标题中
挑战选择
与事件选择类似：
- 在表格中浏览挑战（ID、姓名、难度、分数）
- 在右侧面板中查看详细的挑战信息
- 选择一个挑战以自动填充工具参数
工具执行
- 从下拉列表中选择一个工具
- 查看表中的参数架构
- 编辑JSON参数（提供预填模板）
- 点击“执行”运行工具
- 结果显示在结果屏幕中
- 将结果保存为JSON或Markdown
导出数据
所有结果屏幕都提供导出选项：
- 保存到.json -带时间戳的完整数据结构
- 保存到.md -格式化Markdown输出
文件保存到 htb_mcp_output/ 目录。
📦 项目结构
HTB-MCP-Client/
├── htb_mcp_client.py # Main TUI application
├── requirements.txt # Python dependencies
├── .env.example # Environment template
├── LICENSE # MIT License
├── CHANGELOG.md # Version history
├── README.md # This file
└── htb_mcp_output/ # Output directory (created automatically)🛠️ 发展
打包项目
pip install build
python -m build在开发模式下安装
pip install -e .📝 配置
客户端支持通过环境变量或 .env 文件：
| 变量 | 必填 | 默认 | 描述 |
|---|---|---|---|
API_ACCESS_TOKEN | 是 | - | 您的HackTheBox API JWT代币 |
HTB_MCP_URL | 没有 | https://mcp.hackthebox.ai/v1/ctf/mcp/ | MCP服务器端点 |
🐛 故障排除
“API_ACCESS_TOKEN未设置”错误
确保您已创建 .env 使用您的令牌创建文件：
cp .env.example .env
# Edit .env and add your token连接问题
验证您的令牌是否有效且未过期。您可以从HackTheBox配置文件设置中生成新令牌。
模块导入错误
确保安装了所有依赖项：
pip install -r requirements.txt🤝 贡献
欢迎投稿！请随时提交拉取请求。
- 复刻仓库
- 创建功能分支(
git checkout -b feature/AmazingFeature) - 提交您的更改(
git commit -m 'Add some AmazingFeature') - 推到分支(
git push origin feature/AmazingFeature) - 打开拉取请求
📄 许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
🙏 致谢
- 内置于 文本的 -令人惊叹的TUI框架
- 由...驱动 HackTheBox MCP API
- MCP SDK Anthropic
📚 相关项目
- HackTheBox -网络安全培训平台
- 模型上下文协议 -标准化AI应用集成
🔗 链接
______________________________________________________________________