集群管理协议服务器

一个为Red Hat OpenShift集群管理器(OCM)API操作设计的模型上下文协议(MCP)服务器,提供30种只读工具用于集群管理、监控、账户操作和基础设施检查。

  • by judexzhu
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 judexzhu/mcp-ocm

使用说明

OCM MCP服务器

用于Red Hat OpenShift Cluster Manager(OCM)API操作的模型上下文协议(MCP)服务器。提供30个只读工具,用于集群管理、监控、帐户操作和基础架构检查。支持HCP(托管控制平面)和具有自动类型检测的经典集群。

安装

先决条件

设置

  1. 克隆并安装

    git clone <repository-url>
    cd mcp-ocm
    uv sync
    
  2. 环境配置 创建一个 .env 使用您的Red Hat API凭据提交文件:

    # Required: Your Red Hat API offline token
    RH_API_OFFLINE_TOKEN=your_offline_token_here
    
    # Optional: OCM API base URL (defaults to https://api.openshift.com)
    OCM_BASE_URL=https://api.openshift.com
    

    从以下位置获取离线令牌 Red Hat API代币.

用法

MCP客户端配置

{
  "mcpServers": {
    "ocm": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/your/mcp-ocm",
        "run",
        "ocm_mcp_server.py"
      ],
      "env": {
        "RH_API_OFFLINE_TOKEN": "your_actual_offline_token_here"
      }
    }
  }
}

工具参考(30个工具)

集群信息和搜索

工具 目的
ocm_get_cluster HCP/Classic检测的群集详细信息
ocm_search_clusters 按名称、州、地区等搜索集群。(OCM搜索语法)
ocm_get_cluster_status 群集状态(DNS就绪、配置状态、运行状况)
ocm_get_cluster_resources 当前可用的群集资源(CPU、内存)

池和节点

工具 目的
ocm_get_cluster_machine_pools 机器池(经典)或节点池(HCP)--自动检测

日志

工具 目的
ocm_get_cluster_service_logs 带分页的服务日志(页面/大小参数)
ocm_get_cluster_install_logs 安装日志和历史记录
ocm_get_cluster_uninstall_logs 卸载日志

监控和指标

工具 目的
ocm_get_cluster_alerts 具有严重性细分的群集警报
ocm_get_cluster_operators 操作员状态及状态摘要
ocm_get_cluster_cpu_metrics 按节点角色和操作系统划分的CPU指标
ocm_get_cluster_socket_metrics 按节点角色和操作系统划分的套接字度量
ocm_get_cluster_node_metrics 节点指标

网络

工具 目的
ocm_get_cluster_vpc VPC信息及子网分析(公共/私有)
ocm_get_cluster_ingress 入口配置和DNS信息
ocm_get_cluster_private_link AWS专用链接配置

身份验证和访问

工具 目的
ocm_get_cluster_identity_providers 身份提供程序配置
ocm_get_cluster_groups RBAC组及其用户

配置

工具 目的
ocm_get_cluster_addons 已安装的附加组件
ocm_get_cluster_autoscaler 群集自动缩放器配置
ocm_get_cluster_kubelet_configs Kubelet配置
ocm_get_cluster_upgrade_policies 升级策略(经典+HCP控制平面+节点池)

支持和诊断

工具 目的
ocm_get_cluster_limited_support_reasons 有限的支持原因
ocm_get_cluster_inflight_checks 机上检查(配置调试)

AWS/基础设施

工具 目的
ocm_get_cluster_sts_operator_roles STS操作员IAM角色
ocm_get_cluster_provision_shard 提供分片信息

账户API

工具 目的
ocm_get_accounts_by_email 通过电子邮件查找帐户
ocm_get_subscription 订阅详细信息
ocm_get_organization 组织详细信息
ocm_get_current_account 当前已验证的用户信息

API覆盖范围

集群管理API(clusters_mgmt/v1)

  • 集群搜索、详细信息、状态、资源
  • 机器池/节点池
  • 升级策略(集群、控制平面、节点池)
  • VPC、ingress、身份提供者
  • 警报、操作员、CPU/插槽/节点指标
  • 插件、自动缩放器、kubelet配置、组
  • 有限的支持原因,机上检查
  • AWS专用链接、STS操作员角色、配置碎片
  • 安装/卸载日志

服务日志API(service_logs/v1)

  • 带分页的群集服务日志

账户管理API(accounts_mgmt/v1)

  • 通过电子邮件搜索帐户
  • 订阅、组织
  • 经常账户

依赖项

  • httpx --异步HTTP客户端
  • mcp[cli] --模型上下文协议框架
  • python dotenv --环境变量管理

许可证

该项目根据MIT许可证获得许可。