使用说明

项目简介

CF Kaizen 是一个 Spring Boot 项目,提供了 MCP (Model Context Protocol) 服务器,作为 Cloud Foundry 的 Butler 和 Hoover API 的接口。它使得大型语言模型 (LLM) 能够通过标准化的 MCP 协议与 Cloud Foundry 环境进行交互,访问由 Butler 和 Hoover 提供的资源和工具。

主要功能点

  • Cloud Foundry Butler API 工具: 将 Cloud Foundry Butler API 的功能以 MCP 工具的形式暴露出来,例如获取应用使用报告、管理策略等。
  • Cloud Foundry Hoover API 工具: 将 Cloud Foundry Hoover API 的功能以 MCP 工具的形式暴露出来,例如获取系统 демографика 信息、快照详情等。
  • 双 MCP 服务器实现: 包含 'cf-kaizen-butler-server' 和 'cf-kaizen-hoover-server' 两个独立的 MCP 服务器实现,分别对应 Butler 和 Hoover API。
  • Spring AI 集成: 与 Spring AI 框架集成,方便 LLM 应用的开发和使用。
  • SSE 传输协议支持: 支持 SSE (Server-Sent Events) 协议进行 MCP 通信。

安装步骤

  1. 克隆仓库: 使用 Git 命令克隆 GitHub 仓库到本地:
    git clone https://github.com/cf-toolsuite/cf-kaizen
  2. 进入项目目录: 导航到克隆下来的项目目录:
    cd cf-kaizen
  3. 构建项目: 使用 Maven 构建项目,生成可执行的 JAR 文件:
    ./mvnw clean install

服务器配置 (MCP 客户端)

要将 CF Kaizen MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),您需要编辑客户端的配置文件(通常是 JSON 格式)。以下是针对 'cf-kaizen-butler-server' 和 'cf-kaizen-hoover-server' 的配置示例。

'cf-kaizen-butler-server' 配置示例:

"cf-kaizen-butler-client": {
  "command": "java",
  "args": [
    "-jar",
    "-Ddefault.url=<cf-butler-api-endpoint>",  // 替换为您的 cf-butler API 端点
    "<path-to-project>/target/cf-kaizen-butler-server-0.0.1-SNAPSHOT.jar" // 替换为 cf-kaizen-butler-server JAR 文件的实际路径
  ]
}

'cf-kaizen-hoover-server' 配置示例:

"cf-kaizen-hoover-client": {
  "command": "java",
  "args": [
    "-jar",
    "-Ddefault.url=<cf-hoover-api-endpoint>",  // 替换为您的 cf-hoover API 端点
    "<path-to-project>/target/cf-kaizen-hoover-server-0.0.1-SNAPSHOT.jar" // 替换为 cf-kaizen-hoover-server JAR 文件的实际路径
  ]
}

配置说明:

  • '"command": "java"': 指定启动服务器的命令为 'java'。
  • '"args": [...]': 启动参数列表:
    • '"-jar"': 表示执行 JAR 文件。
    • '"-Ddefault.url=<cf-*-api-endpoint>"': 设置 'default.url' 环境变量,请替换 '<cf-butler-api-endpoint>' 或 '<cf-hoover-api-endpoint>' 为您实际的 Cloud Foundry Butler 或 Hoover API 端点 URL
    • '"<path-to-project>/target/cf-kaizen-*-server-0.0.1-SNAPSHOT.jar"': 请替换 '<path-to-project>' 为您本地项目目录的绝对路径, 确保指向构建生成的 'cf-kaizen-butler-server' 或 'cf-kaizen-hoover-server' JAR 文件。

操作步骤:

  1. 根据您的需求选择 'cf-kaizen-butler-server' 或 'cf-kaizen-hoover-server' 的配置示例。
  2. 将配置示例添加到您的 MCP 客户端配置文件中 (例如 Claude Desktop 的 'claude_desktop_config.json')。
  3. 务必替换配置示例中的占位符 '<cf-*-api-endpoint>' 和 '<path-to-project>' 为您的实际值。
  4. 重启 MCP 客户端,使配置生效。

基本使用方法

配置完成后,您的 MCP 客户端将能够连接到 CF Kaizen MCP 服务器。您可以通过自然语言与 LLM 交互,利用由 Butler 和 Hoover API 提供的工具来查询和操作 Cloud Foundry 环境的信息。例如,您可以询问关于 Cloud Foundry 应用使用情况、系统 демографика 信息、或执行策略等。

信息

分类

开发者工具