项目简介

buildkite-mcp-server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它作为 Buildkite CI/CD 平台与支持 MCP 的大型语言模型 (LLM) 客户端之间的桥梁。它允许 LLM 通过标准化的 JSON-RPC 协议访问 Buildkite 的数据和功能,从而提升 LLM 在 CI/CD 场景下的应用能力。

主要功能点

该服务器提供了一系列工具(Tools),允许 LLM 客户端执行以下操作:

  • 流水线管理: 获取特定流水线的详细信息,或列出 Buildkite 组织中的所有流水线。
  • 构建管理: 列出特定流水线中的所有构建,或获取特定构建的详细信息。
  • 日志访问: 获取 Buildkite 中某个特定作业的运行日志。
  • 制品管理: 列出特定作业的所有制品,或下载某个特定的制品。
  • 用户信息: 获取当前 Buildkite 用户的信息。
  • 组织信息: 获取用于认证请求的 API Token 所关联的 Buildkite 组织信息。

此外,服务器还可能定义 Prompt 模板,指导 LLM 在与 Buildkite 交互时的行为模式。

安装步骤

推荐使用 Docker 镜像运行服务器:

  1. 拉取预构建的 Docker 镜像:
    docker pull ghcr.io/buildkite/buildkite-mcp-server

您也可以从源代码构建可执行文件:

  1. 安装 Go 环境。
  2. 克隆仓库。
  3. 使用 goreleaser 或 Go 构建命令生成可执行文件。

服务器配置

MCP 服务器需要通过 MCP 客户端(如 Claude Desktop, GitHub Copilot 等)进行配置和启动。您需要在客户端的配置中指定如何启动这个 Buildkite MCP 服务器进程。

配置信息通常包括:

  • 服务器名称 (name): 用于标识这个 Buildkite 服务器,例如 "buildkite"。
  • 命令 (command): 启动服务器的命令。如果使用 Docker,通常是 'docker'。如果本地安装,则是 'buildkite-mcp-server' 可执行文件的路径。
  • 参数 (args): 传递给命令的参数,用于指定 MCP 传输协议。对于标准输入输出连接,通常是 'stdio'。如果使用 Docker,可能还需要包含 'run', '-i', '--rm', '-e BUILDKITE_API_TOKEN', 镜像名称等参数。
  • 环境变量 (env): 传递给服务器进程的环境变量。最重要的是 'BUILDKITE_API_TOKEN',需要设置为您的 Buildkite API Token。请确保该 Token 具有读取 Buildkite 资源的权限。

您需要在 Buildkite 网站上生成一个具有必要权限的 API Token,然后在您的 MCP 客户端配置中使用它。

基本使用方法

  1. 确保您的 MCP 客户端已安装并配置了 Buildkite MCP 服务器(如上所述)。
  2. 启动您的 MCP 客户端。客户端会根据配置启动 Buildkite MCP 服务器进程,并通过标准输入输出(或其他配置的协议)进行通信。
  3. 在 MCP 客户端的交互界面中,您可以直接向 LLM 提出与 Buildkite 相关的问题或指令,例如:“列出我的 Buildkite 流水线”、“获取项目 xyz 中最新构建的日志”。LLM 会自动识别并调用 Buildkite MCP 服务器提供的工具来获取信息或执行操作。

信息

分类

开发者工具