Bugzilla MCP Server

关键词

BugzillaREST APIBug trackingAI integration

使用说明内容（Markdown格式）

Bugzilla MCP 服务器使用指南

  • 项目简介

    • 这是一个基于 MCP（Model Context Protocol）的后端服务，专门将 Bugzilla 的功能暴露为可被大模型或其他 MCP 客户端调用的工具、资源访问接口与提示模板，方便在对话中获取 bug 信息、添加评论、快速搜索等能力，并提供会话级别的上下文管理与认证。

  • 主要功能点

    • 提供工具接口：
      • bug_info(id): 获取指定 bug 的完整信息
      • bug_comments(id, include_private_comments=False): 获取公开/私有注释
      • add_comment(bug_id, comment, is_private=False): 给 bug 添加注释
      • bugs_quicksearch(query, status="ALL", include_fields="...", limit=50, offset=0): 使用 Quicksearch 进行 bug 检索
      • learn_quicksearch_syntax(): 获取 Quicksearch 语法文档
      • server_url(): 返回 Bugzilla 服务器基地址
      • bug_url(bug_id): 构造特定 bug 的 URL
      • mcp_server_info(): 返回当前服务器配置信息
      • get_current_headers(): 返回当前请求中的 HTTP headers
    • 提供 Prompts（模板）：
      • summarize_bug_comments(id): 生成对某个 bug 注释的摘要提示（供 LLM 生成摘要）
    • 安全与会话管理：
      • 基于上下文变量为每个请求维护 Bugzilla 客户端
      • 通过中间件校验 API Key（Header 可自定义，默认 ApiKey）
    • 支持多传输与 API 调用场景（HTTP 传输、SSE 等，通过 FastMCP 框架实现）

  • 安装步骤

    • 通过官方打包的 CLI 启动（推荐）
      • 安装并执行后端服务（以公开 Bugzilla 实例为例）：
        • 安装后运行：mcp-bugzilla --bugzilla-server https://bugzilla.example.com --host 0.0.0.0 --port 8000
    • 从源码运行
      • 确保 Python 环境就绪
      • 安装依赖并执行入口命令（通常为 mcp-bugzilla 或 python -m mcp_bugzilla）
      • 启动参数示例：
        • --bugzilla-server https://bugzilla.example.com
        • --host 0.0.0.0
        • --port 8000
        • --api-key-header ApiKey
    • 注意
      • MCP 客户端需要提供对接服务器的配置（见下方“服务器配置”部分示例）

  • 服务器配置（MCP 客户端需要的配置信息以 JSON 形式呈现，包含服务器名称、命令及参数等；用于 MCP 客户端搭建对接，不是客户端代码）

    • 示例配置（描述性文本，非代码块形式呈现）：
    • 服务器名称：mcp-bugzilla
    • 启动命令：mcp-bugzilla
    • 参数（按顺序提供）：
      • --bugzilla-server 与 Bugzilla 实例地址（如 https://bugzilla.example.com）
      • --host 指定监听地址（如 0.0.0.0）
      • --port 指定端口（如 8000）
      • --api-key-header 自定义头名称（如 ApiKey，若使用默认则可省略）
    • 说明：
      • 以上参数与仓库源码中的 CLI 参数一致，客户端通过提供这些参数即可与 MCP 服务器建立连接
      • 客户端配置示例（文本描述，不包含具体代码块）
        • server name: mcp-bugzilla
        • command: mcp-bugzilla
        • args: ["--bugzilla-server", "https://bugzilla.example.com", "--host", "0.0.0.0", "--port", "8000", "--api-key-header", "ApiKey"]
    • 备注：
      • 该服务器需要在 Bugzilla 侧具备 REST API 访问能力，并且调用需携带 Bugzilla API Key（在请求头中传递，通过 header 名为 ApiKey（默认）或自定义名称）

  • 基本使用方法

    • 启动后，客户端通过 MCP 流程向服务器请求工具、获取提示与模板等
    • 常见使用场景：
      • 获取某个 bug 的详细信息，或获取该 bug 的全部注释
      • 向 Bugzilla 添加评论（公开/私有）
      • 使用快速检索（quicksearch）在 Bugzilla 中查找相关问题
      • 获取快速检索语法文档，供模型自行学习
    • 认证方式：请求需要包含 API Key（默认头名 ApiKey），可在服务器启动时通过参数调整头名称
    • 使用注意：如遇网络错误、Bugzilla 请求失败等，将以 ToolError 报错返回

  • 基本使用示例（概念性）

    • 通过 MCP 客户端调用 tool：bug_info、bugs_quicksearch、add_comment 等以获取/操作 Bugzilla 资源
    • 使用 summarize_bug_comments 作为对话中的摘要提示模板，帮助 LLM 输出结构化的注释摘要

服务器信息

访问项目