使用说明
集成nmap的MCP服务器
一个与LMStudio集成并提供OpenAI兼容端点的模型上下文协议(MCP)服务器。该服务器包含用于nmap命令的自然语言处理功能以及扫描结果分析功能。
特点/特性
- ✨ 自然语言 → nmap 转换器 (NL2nmap)
- 📊 扫描结果汇总与建议
- 🤖 交互式引出流程
- 📅 已计划/排队中的扫描任务
- 🔒 大型语言模型(LLM)安全与沙盒技术
- 🧪 全面测试
快速入门
- 克隆仓库:
git clone https://github.com/YOUR_USERNAME/mcp-server.git
cd mcp-server
- 创建虚拟环境并安装依赖项:
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
- 配置环境:
创建一个
.env与……一起提交文件
LLM_API_KEY=sk-no-key-required
LLM_BASE_URL=http://127.0.0.1:1234/v1
MODEL_NAME=qwen2.5:3b-instruct-q4_K_M
MCP_SERVER_PORT=8001
- 启动服务器:
python -m uvicorn app.main:app --host 0.0.0.0 --port 8001 --reload
API 端点
聊天完成(或聊天回复)
- POST(邮寄/发布)
/v1/chat/completions- 兼容OpenAI的聊天完成(chat completion)端点
- 支持流式和非流式响应
健康检查
- GET
/v1/health- 返回服务器状态和配置
示例用法
# Basic chat completion request
curl -X POST http://localhost:8001/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{
"model": "qwen2.5:3b-instruct-q4_K_M",
"messages": [{"role": "user", "content": "Say hello!"}],
"stream": false
}'
发展
该项目采用模块化架构:
app/主应用程序包config/配置设置routes/API端点schemas/数据模型services/业务逻辑utils/辅助函数
做出贡献
- 克隆(或“分叉”)该仓库
- 创建你的功能分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推送到分支(
git push origin feature/amazing-feature) - 提交一个拉取请求(或合并请求)
许可证
此项目采用MIT许可证授权——详情请参见LICENSE文件。