使用说明
项目简介
Snyk MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 提供安全漏洞扫描功能。它通过集成 Snyk 的安全扫描能力,使得 LLM 客户端能够通过标准化的 MCP 协议调用 Snyk 的功能,进行代码仓库和 Snyk 项目的安全检测。
主要功能点
- 代码仓库安全扫描:允许 LLM 客户端指定代码仓库的 URL,服务器将使用 Snyk API 对该仓库进行安全漏洞扫描,并返回扫描结果。
- Snyk 项目安全扫描:允许 LLM 客户端指定已在 Snyk 中创建的项目 ID,服务器将扫描该 Snyk 项目,并返回详细的安全问题报告。
- 与 MCP 客户端集成:作为一个标准的 MCP 服务器,它可以与任何支持 MCP 协议的客户端集成,例如 Claude desktop,扩展 LLM 的安全分析能力。
安装步骤
由于该 MCP 服务器以独立的 npm 包形式提供,因此安装步骤非常简单:
- 确保已安装 Node.js 和 npm:您的环境中需要预先安装 Node.js 和 npm (Node 包管理器)。
- 配置 MCP 客户端:无需手动安装服务器代码,通常 MCP 客户端(如 Claude desktop)会负责下载和运行 MCP 服务器。您只需要按照客户端的要求配置服务器信息即可。
服务器配置
以下是在 MCP 客户端中配置 Snyk MCP Server 的示例配置(JSON 格式)。您需要将此配置添加到您的 MCP 客户端配置文件中(例如 Claude desktop 的 'claude-config.json')。
{ "mcpServers": { "snyk": { "command": "npx", "args": [ "-y", "github:Sladey01/mcp-snyk" ], "env": { "SNYK_API_KEY": "YOUR_SNYK_API_KEY" } } } }
配置参数说明:
- '"snyk"': 服务器名称,可以自定义,用于在客户端中标识和引用该服务器。
- '"command": "npx"': 启动服务器的命令,'npx' 用于执行 npm 包。
- '"args": ["-y", "github:Sladey01/mcp-snyk"]': 'npx' 命令的参数,'-y' 表示自动确认安装,'github:Sladey01/mcp-snyk' 指定了要安装和运行的 npm 包来源是 GitHub 仓库 'Sladey01/mcp-snyk'。
- '"env": { "SNYK_API_KEY": "YOUR_SNYK_API_KEY" }': 设置环境变量,'SNYK_API_KEY' 用于存储您的 Snyk API 密钥。请务必将 '"YOUR_SNYK_API_KEY"' 替换为您在 Snyk 官网申请的真实 API 密钥。
基本使用方法
配置完成后,在 MCP 客户端中,您可以使用自然语言指令来调用 Snyk MCP Server 提供的安全扫描功能。以下是一些示例指令:
- 扫描代码仓库: 'Scan repository https://github.com/owner/repo for security vulnerabilities' (将 'https://github.com/owner/repo' 替换为您要扫描的仓库 URL)
- 扫描 Snyk 项目: 'Scan Snyk project project-id-here' (将 'project-id-here' 替换为您在 Snyk 中创建的项目 ID)
客户端会将这些指令转换为 MCP 请求发送给 Snyk MCP Server,服务器执行相应的扫描操作后,会将结果返回给客户端。
信息
分类
开发者工具