使用说明

项目简介

Integrated Platform Environment (IPE) 是一个综合性的平台管理门户,旨在为平台团队提供集中化的管理和监控解决方案。该项目集成了多种功能,包括事件管理、配置管理、监控、报告和自动化。其中,MCP 服务器组件允许平台与大型语言模型 (LLM) 客户端进行交互,扩展了平台的能力,使得 LLM 能够理解和操作平台环境。

主要功能点

  • Kubernetes 资源查询: 集成了 Kubernetes MCP 服务器,允许 LLM 客户端通过调用 'getk8sPods' 工具查询 Kubernetes 集群中 Pod 的信息。
  • Elasticsearch 异常查询 (占位功能): 包含 Elastic MCP 服务器的框架,虽然 'find_exceptions' 工具目前返回占位信息,但预留了未来集成 Elasticsearch 查询异常日志的功能。
  • Grafana Prometheus 查询 (占位功能): 包含 Grafana MCP 服务器的框架,'query_prometheus' 工具目前返回占位信息,但预留了未来集成 Grafana 和 Prometheus 查询监控指标的功能。
  • 工具扩展性: MCP 服务器的设计支持轻松扩展,可以根据需要添加更多工具,连接到不同的数据源和服务。
  • 集成平台环境: 作为 IPE 平台的一部分运行,与平台的用户界面和后端 API 协同工作,为用户提供统一的平台管理体验。

安装步骤

  1. 克隆代码仓库:

    git clone https://github.com/ewfx/gaipl-auto-hackerss.git
    cd gaipl-auto-hackerss
  2. 切换到 'api' 目录:

    cd code/src/api
  3. 安装后端依赖:

    uv pip install -r requirements.txt
  4. 给予 MCP 脚本执行权限 (Kubernetes MCP Server 示例需要):

    chmod +x ../mcp/scripts/read_file.sh
  5. 设置环境变量: 在运行后端 API 服务之前,需要设置以下环境变量:

    export GOOGLE_API_KEY=你的Google_API_Key  # 如果使用 LLM 功能,请替换为您的 Google API 密钥
    export MCP_SERVER_PATH=../mcp/kubernetes.py # 默认配置为 Kubernetes MCP Server,您可以根据需要更改

    注意: 'MCP_SERVER_PATH' 环境变量指定了要启动的 MCP 服务器脚本的路径。您可以根据需要选择 'kubernetes.py', 'elastic.py' 或 'grafana.py'。 例如,要使用 Elastic MCP 服务器,请将 'MCP_SERVER_PATH' 设置为 '../mcp/elastic.py'。

  6. 运行后端 API 服务:

    uvicorn api:app --reload

    或者使用 Python 运行:

    python app.py
  7. (可选) 运行前端界面: 如果您需要使用完整的前端用户界面进行交互,请执行以下步骤:

    cd ../frontend
    npm install
    npm start

    前端界面通常运行在 'http://localhost:3000'。

服务器配置

MCP 客户端 (例如,IPE 平台的后端 API) 需要配置连接 MCP 服务器的信息。以下是 Kubernetes MCP Server 的配置示例,客户端需要配置类似的信息才能连接到不同的 MCP 服务器:

{
  "server name": "KubernetesMCP",
  "command": "python",
  "args": ["path/to/gaipl-auto-hackerss/code/src/mcp/kubernetes.py"]
}

配置参数说明:

  • 'server name': MCP 服务器的名称,用于客户端标识。例如,Kubernetes MCP 服务器可以命名为 "KubernetesMCP"。
  • 'command': 启动 MCP 服务器进程的命令。对于 Python 编写的 MCP 服务器,通常设置为 "python"。
  • 'args': 启动命令的参数列表,至少需要包含 MCP 服务器脚本的路径。 例如,'["path/to/gaipl-auto-hackerss/code/src/mcp/kubernetes.py"]',请根据实际的文件路径进行调整。

基本使用方法

  1. 启动 MCP 服务器: 根据您的需求,启动 Kubernetes, Elastic 或 Grafana MCP 服务器中的一个或多个。例如,要启动 Kubernetes MCP 服务器,请直接运行 'code/src/mcp/kubernetes.py' 脚本。
  2. 启动 IPE 平台后端 API: 确保在启动后端 API ('api.py') 之前,已正确设置 'MCP_SERVER_PATH' 环境变量,指向您希望使用的 MCP 服务器脚本。
  3. 通过前端或 API 交互: 您可以通过 IPE 平台的前端用户界面与系统进行交互。平台中集成的聊天机器人功能将利用 MCP 服务器提供的工具来增强其能力。例如,您可以向聊天机器人询问 Kubernetes Pod 的状态信息。
  4. LLM 客户端工具调用: LLM 客户端可以通过 JSON-RPC 协议与 MCP 服务器进行通信,并调用服务器注册的工具 (例如 'getk8sPods') 来获取实时的平台上下文信息或执行特定的管理操作。

关键词 平台监控, 平台管理, Kubernetes, 上下文感知, LLM工具

信息

分类

开发者工具