OCM MCP Server

OCM MCP 服务

用于执行 Red Hat OpenShift Cluster Manager（OCM）API 操作的模型上下文协议（MCP）服务。提供 30 个只读工具，用于集群管理、监控、账户操作和基础设施检查。支持 HCP（Hosted Control Plane）和 Classic 集群，并可自动检测集群类型。

安装

先决条件

• Python 3.13+
• uv 包管理器

设置

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 Tokens 获取离线令牌。

使用方法

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	Machine pool（Classic）或 node pool（HCP）——自动检测

日志

工具	用途
ocm_get_cluster_service_logs	服务日志，支持分页（page/size 参数）
ocm_get_cluster_install_logs	安装日志和历史记录
ocm_get_cluster_uninstall_logs	卸载日志

监控与指标

工具	用途
ocm_get_cluster_alerts	集群告警及严重性分类
ocm_get_cluster_operators	Operator 状态及条件摘要
ocm_get_cluster_cpu_metrics	按节点角色和操作系统分类的 CPU 指标
ocm_get_cluster_socket_metrics	按节点角色和操作系统分类的 Socket 指标
ocm_get_cluster_node_metrics	节点指标

网络

工具	用途
ocm_get_cluster_vpc	VPC 信息及子网分析（公有/私有）
ocm_get_cluster_ingress	Ingress 配置和 DNS 信息
ocm_get_cluster_private_link	AWS Private Link 配置

身份验证与访问

工具	用途
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	升级策略（Classic + HCP 控制平面 + 节点池）

支持与诊断

工具	用途
ocm_get_cluster_limited_support_reasons	有限支持的原因
ocm_get_cluster_inflight_checks	正在进行的检查（用于配置问题排查）

AWS / 基础设施

工具	用途
ocm_get_cluster_sts_operator_roles	STS Operator 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、入口、身份提供商
• 告警、运算符、CPU / 套接字 / 节点指标
• 附加组件、自动扩缩器、kubelet 配置、组
• 有限支持原因、进行中的检查
• AWS Private Link、STS 运算符角色、预置分片
• 安装 / 卸载日志

服务日志 API (service_logs/v1)

• 支持分页的集群服务日志

账户管理 API (accounts_mgmt/v1)

• 按电子邮件搜索账户
• 订阅、组织
• 当前账户

依赖项

• httpx — 异步 HTTP 客户端
• mcp[cli] — Model Context Protocol 框架
• python-dotenv — 环境变量管理

许可证

本项目基于 MIT License 授权。