使用说明
项目简介
Netskope NPA MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在通过大型语言模型 (LLM) 客户端,为 Netskope Network Private Access (NPA) 基础设施的管理提供标准化的接口和工具。该服务器允许用户通过自然语言指令,利用 LLM 客户端调用预定义的工具,实现对 Netskope NPA 服务的自动化管理和配置。
主要功能点
- 资源管理: 提供对Netskope NPA基础设施中各种资源的管理能力,包括发布者 (Publishers)、本地 Broker (Local Brokers)、私有应用 (Private Apps)、策略规则 (Policy Rules) 和升级配置 (Upgrade Profiles) 等。
- 工具集成: 集成了丰富的工具集,涵盖 NPA 服务的配置、监控、诊断和维护等方面,例如:
- 管理和监控 Publisher 的状态、版本和升级。
- 管理本地 Broker 的配置和注册。
- 配置私有应用的访问策略和发布设置。
- 管理和配置升级策略,实现自动化升级。
- 提供诊断工具,用于排查用户和设备的连接问题。
- 标准化接口: 遵循 MCP 协议标准,通过 JSON-RPC 协议与客户端通信,提供统一的工具调用和数据访问方式,方便 LLM 客户端集成和使用。
安装步骤
方式一:使用 NPM 包 (推荐)
- 确保已安装 Node.js 和 npm。
- 打开终端,运行以下命令安装 '@johnneerdael/netskope-mcp' 包:
npm install @johnneerdael/netskope-mcp
方式二:本地开发安装
- 确保已安装 Node.js 和 npm,并已安装 Git。
- 克隆 GitHub 仓库到本地:
git clone https://github.com/johnneerdael/netskope-mcp.git cd netskope-mcp - 安装项目依赖:
npm install - 构建项目:
npm run build
服务器配置
以下是 MCP 客户端配置 'netskope-mcp' 服务器的示例,请根据您的操作系统和安装方式选择相应的配置。请将 'https://your-tenant.goskope.com' 和 'your-token' 替换为您的 Netskope 租户 URL 和 API 密钥。
Windows (WSL 环境)
-
NPM 安装:
{ "mcpServers": { "netskope-mcp": { "command": "wsl.exe", "args": [ "bash", "-c", "source ~/.nvm/nvm.sh && NETSKOPE_BASE_URL=https://your-tenant.goskope.com NETSKOPE_API_KEY=your-token npx -y @johnneerdael/netskope-mcp" ] } } }- 'command': 运行的命令,这里使用 'wsl.exe' 在 WSL 环境中执行命令。
- 'args': 命令参数,包括:
- '"bash"': 指定使用 bash shell。
- '"-c"': 执行后面的字符串命令。
- '"source ~/.nvm/nvm.sh && NETSKOPE_BASE_URL=https://your-tenant.goskope.com NETSKOPE_API_KEY=your-token npx -y @johnneerdael/netskope-mcp"': 实际执行的命令,包括:
- 'source ~/.nvm/nvm.sh': 如果使用 nvm 管理 Node.js 版本,需要先加载 nvm 环境。
- 'NETSKOPE_BASE_URL=https://your-tenant.goskope.com NETSKOPE_API_KEY=your-token': 设置 Netskope API 的环境变量,请替换为您的实际值。
- 'npx -y @johnneerdael/netskope-mcp': 使用 npx 运行已安装的 '@johnneerdael/netskope-mcp' 包。
-
本地开发:
{ "mcpServers": { "netskope-mcp": { "command": "wsl.exe", "args": [ "bash", "-c", "cd /path/to/netskope-mcp && NETSKOPE_BASE_URL=https://your-tenant.goskope.com NETSKOPE_API_KEY=your-token node dist/cli.js" ] } } }- 'command': 运行的命令,使用 'wsl.exe' 在 WSL 环境中执行。
- 'args': 命令参数,包括:
- '"bash"': 指定使用 bash shell。
- '"-c"': 执行后面的字符串命令。
- '"cd /path/to/netskope-mcp && NETSKOPE_BASE_URL=https://your-tenant.goskope.com NETSKOPE_API_KEY=your-token node dist/cli.js"': 实际执行的命令,包括:
- 'cd /path/to/netskope-mcp': 切换到本地仓库目录,请替换为您的实际路径。
- 'NETSKOPE_BASE_URL=https://your-tenant.goskope.com NETSKOPE_API_KEY=your-token': 设置 Netskope API 的环境变量,请替换为您的实际值。
- 'node dist/cli.js': 使用 node 运行构建后的服务器入口文件 'dist/cli.js'。
Linux 和 macOS
-
NPM 安装:
{ "mcpServers": { "netskope-mcp": { "command": "npx", "args": ["-y", "@johnneerdael/netskope-mcp"], "env": { "NETSKOPE_BASE_URL": "https://your-tenant.goskope.com", "NETSKOPE_API_KEY": "your-token" } } } }- 'command': 运行的命令,使用 'npx' 直接运行 npm 包。
- 'args': 命令参数,包括:
- '"-y"': 跳过 npm 包安装确认。
- '"@johnneerdael/netskope-mcp"': 指定要运行的 npm 包。
- 'env': 环境变量配置,包括:
- '"NETSKOPE_BASE_URL": "https://your-tenant.goskope.com"': Netskope 租户 URL,请替换为您的实际值。
- '"NETSKOPE_API_KEY": "your-token"': Netskope API 密钥,请替换为您的实际值。
-
本地开发:
{ "mcpServers": { "netskope-mcp": { "command": "node", "args": ["dist/cli.js"], "cwd": "/path/to/netskope-mcp", "env": { "NETSKOPE_BASE_URL": "https://your-tenant.goskope.com", "NETSKOPE_API_KEY": "your-token" } } } }- 'command': 运行的命令,使用 'node' 直接运行 JavaScript 文件。
- 'args': 命令参数,指定服务器入口文件 '"dist/cli.js"'。
- 'cwd': 当前工作目录,指定为本地仓库目录 '/path/to/netskope-mcp',请替换为您的实际路径。
- 'env': 环境变量配置,与 NPM 安装方式相同,请替换为您的实际值。
环境变量
- 'NETSKOPE_BASE_URL': 您的 Netskope 租户的基础 URL,例如 'https://your-tenant.goskope.com'。
- 'NETSKOPE_API_KEY': 用于 Netskope API 鉴权的 API 密钥。
基本使用方法
- 确保已配置并启动 MCP 服务器。
- 在支持 MCP 协议的 LLM 客户端中,配置并连接到 'netskope-mcp' 服务器。
- 使用自然语言指令,通过 LLM 客户端调用服务器提供的工具,管理您的 Netskope NPA 基础设施。
请注意: 该项目目前仍处于开发阶段,部分工具可能尚未完全实现或功能不完善。请谨慎用于生产环境。
信息
分类
商业系统