README
🚀 MCP NMAP 服务器
一个 Model Context Protocol (MCP) 服务器,可让 AI 助手借助 NMAP 开展网络扫描操作。该服务器为 AI 模型提供标准化接口,使其能与 NMAP 交互,进而依托 AI 对话实现网络分析与安全评估。
🚀 快速开始
本服务器可助力 AI 助手使用 NMAP 进行网络扫描,为 AI 模型与 NMAP 交互提供标准化接口。以下是使用前的准备和安装步骤。
✨ 主要特性
- 服务器提供访问 NMAP 核心功能的简单接口。
- 支持快速扫描、完整的端口扫描、版本检测和自定义时间模板。
- 使用 NMAP 本机命令行界面,确保可靠性和与标准 NMAP 操作的一致性。
📦 安装指南
先决条件
- 操作系统:Windows
- Node.js(v18 或更高版本)
- NMAP 已安装并可在 Windows 命令行中使用
- 使用 TypeScript 进行开发
安装方式
通过 Smithery 自动安装
要自动通过 Smithery 安装 NMAP 服务器用于 Claude Desktop,可执行以下命令:
npx -y @smithery/cli install mcp-nmap-server --client claude
手动安装
可选择全局安装或在项目中本地安装:
- 全局安装:
npm install -g mcp-nmap-server
- 本地安装:
npm install mcp-nmap-server
💻 使用示例
与 Claude Desktop 配置
要在 Windows 上将此服务器与 Claude Desktop 一起使用,需在 Claude 配置文件中进行配置,该文件位于:C:\Users\YOUR_USERNAME\AppData\Roaming\Claude\config.json。
通过将 NMAP 服务器添加到 mcpServers 部分来配置。以下是完整的 Claude Desktop 配置文件示例:
{
"mcpServers": {
"nmap": {
"command": "node",
"args": [
"C:\\Users\\YOUR_USERNAME\\Downloads\\mcp-nmap-server\\dist\\index.js"
]
}
},
"globalShortcut": "Ctrl+Q"
}
请将 YOUR_USERNAME 替换为您的 Windows 用户名,并根据实际情况调整 NMAP 服务器的安装路径。
与 AI 一起使用
配置完成后,AI 助手(如 Claude)可以通过调用 run_nmap_scan 函数使用该服务器。该函数接受以下参数:
{
target: string; // 要扫描的目标主机或网络
ports?: string; // 可选端口规范(例如,“80,443”或“1-1000”)
scanType?: 'quick' | 'full' | 'version'; // 扫描类型(默认:'quick')
timing?: number; // NMAP 时间模板 0 - 5(默认:3)
additionalFlags?: string; // 可选的额外 NMAP 标志
}
与 Claude 对话示例:
人类:你能扫描本地主机上的开放端口吗?
Claude:我将帮助您使用 NMAP 扫描本地主机。
<执行目标为 localhost、类型为 quick、时间设为 3 的 nmap 扫描>
📄 许可证
本项目采用 MIT License。
📚 详细文档
有关问题、建议或贡献,请访问 GitHub 仓库。
微信扫一扫