Cloud Foundry MCP Server 使用说明

项目简介

Cloud Foundry MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器端应用,它利用 Spring AI MCP 框架,为大型语言模型 (LLM) 提供与 Cloud Foundry 云平台交互的能力。通过此服务器,LLM 可以调用预定义的工具来管理 Cloud Foundry 环境中的应用程序、服务、组织和空间等资源。

主要功能点

  • 应用管理: 提供工具用于查询应用列表、获取应用详情、推送应用、伸缩应用、启动/停止/重启/删除应用。
  • 服务管理: 提供工具用于查询服务实例列表、获取服务实例详情、查询服务产品、绑定/解绑/删除服务实例。
  • 组织和空间管理: 提供工具用于查询组织列表、查询空间列表以及获取空间配额信息。
  • 基于 Tool 的能力暴露: 通过 Spring AI 的 '@Tool' 注解,将 Cloud Foundry 的操作封装成可被 LLM 调用的工具。
  • 标准 MCP 协议: 理论上支持基于 JSON-RPC 的 MCP 客户端连接和通信 (仓库未明确提及 Prompt 模板和 Resource 托管,主要聚焦 Tools 功能)。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/cpage-pivotal/cloud-foundry-mcp.git
    cd cloud-foundry-mcp
  2. 构建服务器: 使用 Maven 构建项目,生成可执行的 JAR 文件。
    ./mvnw clean package
    构建成功后,JAR 文件通常位于 'target' 目录下,例如 'cloud-foundry-mcp-0.0.1-SNAPSHOT.jar'。

服务器配置

MCP 客户端需要配置连接 Cloud Foundry MCP Server 的信息。以下是一个示例 'claude_desktop_config.json' 配置,你需要根据实际情况修改:

{
  "mcpServers": {
    "cloud-foundry": {
      "command": "java",
      "args": [
        "-Dspring.ai.mcp.server.transport=stdio",  // 指定 MCP 服务器使用 stdio 传输协议
        "-Dlogging.file.name=cloud-foundry-mcp.log", // 配置日志文件名为 cloud-foundry-mcp.log
        "-jar" ,
        "/path/to/cloud-foundry-mcp/target/cloud-foundry-mcp-0.0.1-SNAPSHOT.jar", //  替换为实际的 JAR 文件路径
        "--server.port=8040" //  指定服务器端口为 8040 (此参数可能不需要,取决于服务器实际配置)
      ],
      "env": {
        "CF_APIHOST": "[Your CF API Endpoint e.g. api.sys.mycf.com]", //  Cloud Foundry API Endpoint,例如 api.sys.mycf.com
        "CF_USERNAME": "[Your CF User]", //  Cloud Foundry 用户名
        "CF_PASSWORD": "[Your CF Password]", //  Cloud Foundry 密码
        "CF_ORG": "[Your Org]", //  Cloud Foundry 组织
        "CF_SPACE": "[Your Space]" //  Cloud Foundry 空间
      }
    }
  }
}

注意:

  • 请将 '/path/to/cloud-foundry-mcp/target/cloud-foundry-mcp-0.0.1-SNAPSHOT.jar' 替换为实际构建生成的 JAR 文件路径。
  • 配置文件中的 'CF_APIHOST', 'CF_USERNAME', 'CF_PASSWORD', 'CF_ORG', 'CF_SPACE' 等环境变量需要替换为你的 Cloud Foundry 账户和环境信息。
  • 'transport' 参数指定了 MCP 服务器使用的传输协议,这里示例为 'stdio'。
  • 'server.port' 参数在示例中出现,但实际 Spring Boot 应用的端口配置可能通过其他方式实现,请根据实际情况调整。

基本使用方法

  1. 启动 MCP 服务器: 根据 'claude_desktop_config.json' 中的配置,MCP 客户端会通过 'command' 和 'args' 启动 Cloud Foundry MCP Server。 通常情况下,MCP 客户端会自动处理服务器的启动。

  2. 配置 MCP 客户端: 将生成的 'claude_desktop_config.json' 文件配置到支持 MCP 协议的 LLM 客户端 (例如 Claude Desktop) 中。

  3. 与 LLM 交互: 在 LLM 客户端中,你可以指示 LLM 使用 Cloud Foundry 相关的工具来完成任务,例如:

    • "列出我在 Cloud Foundry 空间中的所有应用"
    • "获取名为 my-app 的应用的详细信息"
    • "启动应用 another-app"
    • "在我的空间中创建新的服务实例"

    LLM 客户端会根据你的指令,调用 Cloud Foundry MCP Server 提供的工具,并返回结果。

重要提示:

  • 此 MCP 服务器主要通过 Tool 功能与 LLM 交互,资源 (Resources) 和 Prompt 模板 (Prompts) 的支持程度需要进一步验证仓库代码或文档。
  • 使用前请务必仔细阅读仓库的 README 文件和 Spring AI MCP 的相关文档,了解更详细的配置和使用方法。
  • 请妥善保管 Cloud Foundry 账户信息,避免泄露。

信息

分类

开发者工具