mcp-server-operator

MCP 服务 Operator

MCP 服务 Operator 用于管理 OpenShift 集群上 MCP（Model Context Protocol）服务的生命周期。它利用名为 MCPServer 的自定义资源定义（CRD），允许用户指定 MCP 服务镜像和运行时参数，以部署自定义 MCP 服务。

功能

• 通过 CRD 部署和管理 MCP 服务实例
• 支持自定义容器镜像和运行时参数
• 兼容 Openshift 集群
• 包含端到端测试和单元测试。

目录

• 项目概览
• 功能
• 用法
  • 先决条件
  • 安装
  • 在本地运行 Operator
  • 在集群上运行 Operator
  • 创建 MCP 服务实例
  • 卸载 Operator 并清理集群
• 开发者指南
  • 先决条件
  • 运行测试
  • 贡献

用法

先决条件

安装前，需要具备以下条件才能运行 Operator：

• 一个 OpenShift 集群（ROSA、OSD、CRC）或兼容的 Kubernetes 集群
• 一个 容器引擎（podman 或 docker）
• OpenShift CLI 工具：oc
• 安装 CRD 和部署 Operator 所需的权限

安装

执行以下步骤前，如果要使用集群，请确保已登录集群：

oc login --token=<your user token> --server=<your openshift cluster server>

登录集群后，克隆仓库，然后切换到 mcp-server-operator 文件夹：

git clone https://github.com/opendatahub-io/mcp-server-operator.git

cd mcp-server-operator

接下来，设置环境变量：

export IMG=<your-registry>/<username>/mcp-server-operator:<tag>

之后，构建镜像：

CONTAINER_TOOL={docker|podman} IMG=$IMG make build

然后，安装所需的 CRD：

make install

在本地运行 Operator

make run

在集群上运行 Operator

make deploy IMG=$IMG

创建 MCP 服务实例

以下示例展示了如何创建 MCPServer。运行命令前，请确保将方括号中的文本替换为相应信息。

cat << EOF | oc create -f -
apiVersion: mcpserver.opendatahub.io/v1
kind: MCPServer
metadata:
  name: <your_name_here>
  namespace: mcp-server-operator-system
spec:
  image: <your_image_here>
  args:
    - <arg 1>
    - <arg 2>
  command:
    - <command 1>
    - <command 2>
EOF

字段说明

• image：MCP 服务的容器镜像。
• args：（可选）要传递给 MCP 服务容器的运行时参数列表。
• command：（可选）要传递给 MCP 服务容器的入口点命令列表。

卸载 Operator 并清理集群

首先，使用以下命令从集群中删除 MCPServer 对象：

oc delete mcpserver -n mcp-server-operator-system [name]

接下来，运行以下命令即可卸载 Operator。

make undeploy

开发者指南

先决条件

• Go 1.23
• Kubebuilder

运行测试

运行单元测试：

make test

运行端到端测试：

make test-e2e

贡献

欢迎贡献！请参阅我们的贡献指南。