CSW MCP服务器

一个提供访问Cisco Secure Workload (CSW) API端点的模型上下文协议(MCP)服务器,用于管理范围、搜索库存和网络流、管理代理和工作区等。

  • by jquintero17
  • JavaScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 jquintero17/CSW-MCP-SERVER

使用说明

CSW MCP服务器

模型上下文协议(MCP)服务器,提供对Cisco安全工作负载(CSW)API端点的访问。

项目结构

此存储库包含两个MCP服务器实现:

  • CSW-MCP-SERVER (当前目录):基本服务器,配备11个核心工具,用于基本的CSW操作
  • CSW-MCP-SERVER用户指南/:具有55个综合工具的增强型服务器,涵盖了CSW API功能的95%

概述

此MCP服务器允许您通过模型上下文协议与思科安全工作负载进行交互,提供以下工具:

  • 列出并管理范围
  • 搜索库存和网络流量
  • 管理代理和工作区
  • 查看漏洞
  • 还有更多!

有关全面的功能,请参阅 CSW-MCP-SERVER用户指南 目录。

安装

  1. 安装依赖项:

    npm install
    
  2. 构建项目:

    npm run build
    

用法

运行服务器

服务器可以通过多种方式启动:

开发模式(自动重新加载):

npm run dev

生产方式:

npm start

直接执行:

node dist/index.js

配置

在使用CSW工具之前,必须使用 csw_configure 工具:

{
  "cluster_url": "https://your-cluster.tetrationcloud.com",
  "api_key": "your_api_key",
  "api_secret": "your_api_secret"
}

可用工具

配置

  • csw_configure -使用API凭据配置CSW连接

范围管理

  • csw_list_scopes -列出所有可用范围
  • csw_get_scope -获取特定范围的详细信息

库存和搜索

  • csw_list_inventory_filters -列出库存筛选器
  • csw_search_inventory -基于过滤器搜索库存
  • csw_search_flows -搜索网络流

代理商管理

  • csw_list_agents -列出CSW代理
  • csw_get_agent -获取特定代理的详细信息

工作区

  • csw_list_workspaces -列出应用程序策略工作区
  • csw_get_workspace -获取特定工作空间的详细信息

安全

  • csw_list_vulnerabilities -列出检测到的漏洞

API身份验证

服务器使用CSW的API身份验证机制,其中:

  • API密钥和秘密
  • HMAC-SHA256签名生成
  • 基于时间戳的身份验证

错误处理

该服务器包括全面的错误处理功能,用于:

  • 网络连接问题
  • 身份验证失败
  • API速率限制
  • 无效参数
  • CSW API错误

发展

项目结构

src/
├── index.ts          # Main MCP server implementation
├── csw-client.ts     # CSW API client
├── config.ts         # Configuration validation
└── types.ts          # TypeScript type definitions

建筑

npm run build

例子

基本使用流程

  1. 配置服务器:

    # Use the csw_configure tool with your credentials
    
  2. 列表范围:

    # Use csw_list_scopes to see available scopes
    
  3. 搜索库存:

    # Use csw_search_inventory with a filter and scope
    

API调用示例

列表范围:

{
  "page_num": 1,
  "page_size": 50
}

搜索库存:

{
  "filter": "ip = 192.168.1.0/24",
  "scope_name": "Production",
  "limit": 100
}

搜索流程:

{
  "start_time": "2024-01-01T00:00:00Z",
  "end_time": "2024-01-01T23:59:59Z",
  "filter": "src_ip = 192.168.1.1",
  "scope_name": "Production"
}

故障排除

常见问题

  1. 身份验证失败

    • 验证API密钥和机密是否正确
    • 检查群集URL格式
    • 确保API凭据具有正确的权限
  2. 网络问题

    • 验证与CSW群集的连接
    • 检查防火墙规则
    • 验证SSL证书
  3. API错误

    • 检查CSW API文件中的参数要求
    • 验证作用域名称是否存在
    • 确保过滤器语法正确

调试模式

通过设置环境变量启用详细日志记录:

DEBUG=csw-mcp-server npm start

服务器比较

CSW-MCP-SERVER(当前目录)

  • 工具:11个核心工具
  • 聚焦:基本的CSW操作
  • 用例:基本自动化和脚本
  • 覆盖:约65-70%的常见CSW API终点

CSW-MCP-SERVER用户指南

  • 工具:55个综合工具
  • 聚焦:全面覆盖CSW API
  • 用例:先进的管理和全面的自动化
  • 覆盖:约95%的CSW API功能
  • 附加功能:VRF、用户、系统运行状况、增强的工作量、高级策略

推荐:将CSW-MCP-SERVER-USERGUIDE用于需要全面CSW管理的生产环境。

贡献

  1. 分叉存储库
  2. 创建要素分支
  3. 进行更改
  4. 提交拉取请求

许可证

MIT许可证-有关详细信息,请参阅许可证文件。

支持

对于问题和疑问:

  • 查看CSW API文档
  • 查看服务器日志中的错误消息
  • 验证网络连接和凭据