bugzilla-mcp 0.6.0__tar.gz

bugzilla_mcp-0.6.0/LICENSE

@@ -0,0 +1,192 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (which shall not include Communications that are clearly marked or
+   otherwise designated in writing by the copyright owner as "Not a Work").
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is clearly marked or otherwise designated
+   in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2025
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

bugzilla_mcp-0.6.0/PKG-INFO

@@ -0,0 +1,467 @@
+Metadata-Version: 2.4
+Name: bugzilla-mcp
+Version: 0.6.0
+Summary: MCP server for Bugzilla: search, read, triage and update bugs from AI assistants. Read-only by default.
+Keywords: mcp,bugzilla,bug-tracking,model-context-protocol,fastmcp
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Bug Tracking
+Requires-Dist: fastmcp>=4.0.11,<5
+Requires-Dist: python-dotenv
+Requires-Dist: httpx
+Requires-Dist: pytest>=8.0.0 ; extra == 'test'
+Requires-Dist: pytest-asyncio>=0.24.0 ; extra == 'test'
+Requires-Dist: pytest-httpx>=0.30.0 ; extra == 'test'
+Requires-Dist: pytest-cov>=4.1.0 ; extra == 'test'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/SanthoshSiddegowda/bugzilla-mcp
+Project-URL: Documentation, https://github.com/SanthoshSiddegowda/bugzilla-mcp#readme
+Project-URL: Issues, https://github.com/SanthoshSiddegowda/bugzilla-mcp/issues
+Project-URL: Changelog, https://github.com/SanthoshSiddegowda/bugzilla-mcp/releases
+Provides-Extra: test
+Description-Content-Type: text/markdown
+
+# Bugzilla MCP Server
+
+![Tests](https://github.com/SanthoshSiddegowda/bugzilla-mcp/actions/workflows/tests.yml/badge.svg)
+
+A Model Context Protocol (MCP) server that enables secure interaction with Bugzilla instances. This server facilitates communication between AI applications and Bugzilla bug tracking systems through a controlled interface.
+
+## Install
+
+The server runs on your machine, so your Bugzilla API key never leaves it. It starts **read-only**: tools that change Bugzilla stay off until you turn them on.
+
+### Claude Desktop: one click
+
+1. Download **[bugzilla-mcp.mcpb](https://github.com/SanthoshSiddegowda/bugzilla-mcp/releases/latest/download/bugzilla-mcp.mcpb)** from the latest release.
+2. Double-click it (or open **Settings → Extensions** and install it there).
+3. Enter your Bugzilla URL and [API key](#api-key). Leave **Read-only** ticked unless you want Claude to update bugs.
+
+No Python or terminal needed. The API key is stored as a secret by Claude Desktop.
+
+### Claude Code
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/) once, then:
+
+```bash
+claude mcp add bugzilla --scope user \
+  -e BUGZILLA_URL=https://bugzilla.example.com \
+  -e BUGZILLA_API_KEY=your-api-key \
+  -- uvx bugzilla-mcp
+```
+
+Add `--allow-writes` after `bugzilla-mcp` to enable write tools. Check it with `claude mcp list`.
+
+### Cursor, VS Code and other MCP clients
+
+```json
+{
+  "mcpServers": {
+    "bugzilla": {
+      "command": "uvx",
+      "args": ["bugzilla-mcp"],
+      "env": {
+        "BUGZILLA_URL": "https://bugzilla.example.com",
+        "BUGZILLA_API_KEY": "your-api-key"
+      }
+    }
+  }
+}
+```
+
+If the client can't find `uvx` (desktop apps don't always load your shell's `PATH`), use the full path from `which uvx`.
+
+### pip
+
+```bash
+pip install bugzilla-mcp
+bugzilla-mcp --help
+```
+
+### Options
+
+| Setting | How | Default |
+|---|---|---|
+| Bugzilla URL | `BUGZILLA_URL` | required |
+| API key | `BUGZILLA_API_KEY` (environment or `.env` only, never a flag) | required |
+| Write tools | `--allow-writes` or `BUGZILLA_READ_ONLY=false` | off |
+| Remove tools | `BUGZILLA_DISABLED_TOOLS=update_bug,create_bug` | none |
+| Run as an HTTP server for several users | `bugzilla-mcp --transport http --host 0.0.0.0 --port 8000` (credentials then come from each request's headers) | stdio |
+
+### API key
+
+Create one in Bugzilla under **Preferences → API Keys** (`https://your-bugzilla/userprefs.cgi?tab=apikey`). The key has the same permissions as your account, so a dedicated account with limited access is safest.
+
+
+## Features
+
+This MCP server provides a comprehensive interface for AI agents to interact with Bugzilla, exposing **28 specialized tools** categorized into:
+
+- **🔍 Advanced Search & Discovery**:
+  - Full-text search with Bugzilla's fast `bugs_quicksearch` syntax.
+  - Multi-criteria `bugs_advanced_search` (filter by product, component, status, severity, keywords, and more).
+  - Browse accessible products (`list_products`) and component schemas (`get_product_components`).
+  - Read a bug (`bug_info`) in compact form by default: empty fields (e.g. unused `cf_*` custom fields) and the `update_token` are dropped. Pass `full=True` for every field.
+
+- **✏️ Write & Comprehensive Updates**:
+  - File new bugs (`create_bug`) with assignees, keywords, severities, and descriptions.
+  - Tools carry MCP hints (`readOnlyHint` / `destructiveHint`), so clients can auto-approve reads and ask before `update_bug` changes a bug.
+  - Atomically update any bug property (`update_bug`) — supports status, resolution, assignments, priority/severity, milestone, version, CC list, keywords, and any custom fields (e.g. `cf_qatouch_id`).
+  - Append public or private comments (`add_comment`) and tag comments semantically (`tag_comment`).
+
+- **📊 Bulk Triage & Analytics**:
+  - Parallel batch retrieval of metadata (`bugs_info`) and comments (`bugs_comments`).
+  - Compress long discussion threads dynamically (`bugs_analysis_context`) to fit in standard LLM context windows.
+  - Categorize bug batches automatically (`classify_bugs_heuristics`) and generate statistical metrics (`analyze_bugs_statistics`). Rules use status and resolution only: closed as INVALID/WONTFIX/DUPLICATE/WORKSFORME/NOTABUG → `invalid`; NEW/ASSIGNED/REOPENED/UNCONFIRMED → `to_fix`; anything else → `review_needed`.
+  - Preview bulk changes with `update_bug(dry_run=True)`, which returns the planned changes and current values without writing.
+
+- **📎 Robust Attachment Handling**:
+  - List a bug's attachments (`bug_attachments`) and read one (`get_attachment`): screenshots come back as images, logs and patches as text.
+  - Attach logs, patches or files (`upload_attachment`) by passing `text` or `data_base64`, with automatic content-type detection.
+  - **Local server only** (`server_local.py`): save attachments to disk (`download_attachments`, `download_attachment`) and upload from a `file_path`. The hosted server doesn't offer the download tools and refuses `file_path`, so callers can't read or write files on the shared machine.
+
+- **👤 User Management & Auditing**:
+  - Audit full change histories (`bug_history`) with time and field filters.
+  - Fetch detailed user profiles (`get_user`) and search user databases (`search_users`).
+  - Traverse dependency/blocker trees (`bug_dependencies`) and resolve duplicate bug chains (`duplicate_chain`).
+
+## HTTP Server Headers
+
+The server requires HTTP headers for authentication. Configure your MCP client with the following headers:
+
+- **`api_key`** (Required) - Your Bugzilla API key
+  - Get your API key from: `https://your-bugzilla-instance.com/userprefs.cgi?tab=apikey`
+- **`bugzilla_url`** (Required) - The base URL of your Bugzilla instance (Bugzilla 5.0+)
+  - Example: `https://bugzilla.test.org`
+
+- **`read_only`** (Optional, default `true`) - The server starts in **read-only mode**: tools that change Bugzilla (`update_bug`, `create_bug`, `add_comment`, `upload_attachment`, `tag_comment`) are hidden and refused. Send `read_only: false` to enable them. For the local stdio server, set `BUGZILLA_READ_ONLY=false` instead.
+
+Self-hosting? `BUGZILLA_READ_ONLY` sets the server's default, and `BUGZILLA_DISABLED_TOOLS=update_bug,create_bug` removes individual tools entirely.
+
+> **How the key is sent**: the server forwards your key to Bugzilla in the `X-BUGZILLA-API-KEY` header. Stock Bugzilla 5.0/5.2 don't support that header, so for them it falls back to `?api_key=` (deprecated, see [Deprecations](#deprecations)).
+>
+> **Hosted server**: when you use `https://bugzilla.fastmcp.app/mcp`, your API key passes through that server on its way to your Bugzilla instance. If you don't want a third party to handle your key, [run the server locally](#running-the-server-locally).
+
+## Try the Hosted Server
+
+Want to try it before installing? A hosted server runs at `https://bugzilla.fastmcp.app/mcp`. Your API key passes through that server on its way to your Bugzilla, so for real use, [install it locally](#install).
+
+### With Claude Code
+
+```bash
+claude mcp add --transport http bugzilla https://bugzilla.fastmcp.app/mcp \
+  --scope user \
+  --header "api_key: your-api-key-here" \
+  --header "bugzilla_url: https://bugzilla.example.com"
+```
+
+`--scope user` makes the server available in all projects and keeps your key out of the repo. Verify with `claude mcp list`, then start a new session.
+
+To share the config with a team via a project `.mcp.json`, reference environment variables instead of hardcoding the key:
+
+```json
+{
+  "mcpServers": {
+    "bugzilla": {
+      "type": "http",
+      "url": "https://bugzilla.fastmcp.app/mcp",
+      "headers": {
+        "api_key": "${BUGZILLA_API_KEY}",
+        "bugzilla_url": "${BUGZILLA_URL}"
+      }
+    }
+  }
+}
+```
+
+### With Claude Desktop
+
+Claude Desktop's `claude_desktop_config.json` only supports local (stdio) servers, so connect through the [`mcp-remote`](https://www.npmjs.com/package/mcp-remote) bridge (requires Node.js):
+
+```json
+{
+  "mcpServers": {
+    "bugzilla": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "mcp-remote",
+        "https://bugzilla.fastmcp.app/mcp",
+        "--header",
+        "api_key:your-api-key-here",
+        "--header",
+        "bugzilla_url:https://bugzilla.example.com"
+      ]
+    }
+  }
+}
+```
+
+Restart Claude Desktop after saving.
+
+> **Note**: For local development, use `http://127.0.0.1:8000/mcp` instead.
+
+### With Cursor IDE
+
+Add this to your `.cursor/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "bugzilla": {
+      "url": "https://bugzilla.fastmcp.app/mcp",
+      "headers": {
+        "api_key": "your-api-key-here",
+        "bugzilla_url": "https://bugzilla.example.com"
+      }
+    }
+  }
+}
+```
+
+> **Note**: For local development, use `http://127.0.0.1:8000/mcp` instead.
+
+### With Visual Studio Code
+
+Add this to your `mcp.json`:
+
+```json
+{
+  "servers": {
+    "bugzilla": {
+      "type": "http",
+      "url": "https://bugzilla.fastmcp.app/mcp",
+      "headers": {
+        "api_key": "your-api-key-here",
+        "bugzilla_url": "https://bugzilla.example.com"
+      }
+    }
+  }
+}
+```
+
+> **Note**: For local development, use `http://127.0.0.1:8000/mcp` instead.
+
+## Run from a Source Checkout
+
+For local development, testing, or self-hosting, you can run the Bugzilla MCP server in two modes: **Local stdio Server** (recommended for personal use/single user) or **Local HTTP Server** (best for multi-user or remote setups).
+
+#### 🛠️ Environment Configuration
+
+Before running either server type, you should configure your Bugzilla credentials. We provide a `.env.example` file in the root of the project to help you get started.
+
+1. **Create your `.env` file**:
+   ```bash
+   cp .env.example .env
+   ```
+2. **Configure your credentials**:
+   Open the `.env` file in your preferred editor and fill in your details:
+   ```ini
+   BUGZILLA_URL=https://bugzilla.example.com
+   BUGZILLA_API_KEY=your-api-key-here
+   ```
+   > [!NOTE]
+   > - **`BUGZILLA_URL`**: The base URL of your Bugzilla instance (e.g. `https://bugzilla.mozilla.org`).
+   > - **`BUGZILLA_API_KEY`**: Your Bugzilla API key. You can generate one from your Bugzilla User Preferences page (usually under `https://your-bugzilla-instance.com/userprefs.cgi?tab=apikey`).
+
+---
+
+#### 1. Local stdio Server (Recommended)
+
+This runs as a background process managed directly by your MCP client (such as Claude Desktop or Cursor) using standard input/output (stdio) transport. It reads credentials securely from your environment variables or the `.env` file.
+
+##### Step 1: Install Dependencies
+
+```bash
+# Using uv (highly recommended)
+uv sync
+
+# Or using standard Python virtual environment
+python -m venv .venv
+source .venv/bin/activate
+pip install .
+```
+
+##### Step 2: Configure MCP Client
+
+Make sure to replace `/absolute/path/to/bugzilla-mcp` with the actual absolute path to this project directory on your machine.
+
+###### **With Claude Desktop**
+Add the following to your `claude_desktop_config.json` (typically located at `~/Library/Application Support/Claude/claude_desktop_config.json` on macOS or `%APPDATA%\Claude\claude_desktop_config.json` on Windows):
+
+```json
+{
+  "mcpServers": {
+    "bugzilla-local": {
+      "command": "uv",
+      "args": [
+        "run",
+        "--directory",
+        "/absolute/path/to/bugzilla-mcp",
+        "python",
+        "server_local.py"
+      ],
+      "env": {
+        "BUGZILLA_URL": "https://bugzilla.example.com",
+        "BUGZILLA_API_KEY": "your-api-key-here"
+      }
+    }
+  }
+}
+```
+
+###### **With Cursor IDE**
+You can configure the server in **Cursor Settings -> Features -> MCP** as a `command` type:
+
+- **Name**: `bugzilla-local`
+- **Type**: `command`
+- **Command**: `uv run --directory /absolute/path/to/bugzilla-mcp python server_local.py`
+
+Or add it directly to your `.cursor/mcp.json` or `mcp.json` if configured programmatically:
+
+```json
+{
+  "mcpServers": {
+    "bugzilla-local": {
+      "command": "uv",
+      "args": [
+        "run",
+        "--directory",
+        "/absolute/path/to/bugzilla-mcp",
+        "python",
+        "server_local.py"
+      ],
+      "env": {
+        "BUGZILLA_URL": "https://bugzilla.example.com",
+        "BUGZILLA_API_KEY": "your-api-key-here"
+      }
+    }
+  }
+}
+```
+
+###### **With Claude Code (CLI)**
+To add the Bugzilla MCP server to Claude Code, run the following command in your terminal:
+
+```bash
+# Add as a project-scoped server (available only in current project)
+claude mcp add bugzilla-local --scope project -- uv run --directory /absolute/path/to/bugzilla-mcp python server_local.py
+
+# Or add as a user-scoped server (available across all projects)
+claude mcp add bugzilla-local --scope user -- uv run --directory /absolute/path/to/bugzilla-mcp python server_local.py
+```
+
+> [!TIP]
+> - By configuring the `.env` file in `/absolute/path/to/bugzilla-mcp`, the server automatically loads your `BUGZILLA_URL` and `BUGZILLA_API_KEY` on startup without needing to pass them explicitly as CLI flags.
+> - You can check the server status in Claude Code using `claude mcp list` or by running the `/mcp` command inside Claude Code. Remember to restart your Claude Code session after adding or modifying the server!
+
+---
+
+#### 2. Local HTTP Server
+
+This runs a local HTTP server with Server-Sent Events (SSE) transport. It's dynamic and validates credentials per-request, meaning clients must supply headers on each call.
+
+##### Step 1: Start the HTTP Server
+
+```bash
+# Start local HTTP server
+uv run python server.py
+```
+The server will start at `http://127.0.0.1:8000/mcp`.
+
+##### Step 2: Configure Client to Use HTTP Server
+
+Configure your MCP clients to use this local URL and provide authentication headers dynamically:
+
+###### **With Claude Desktop or Cursor**
+```json
+{
+  "mcpServers": {
+    "bugzilla-local-http": {
+      "url": "http://127.0.0.1:8000/mcp",
+      "headers": {
+        "api_key": "your-api-key-here",
+        "bugzilla_url": "https://bugzilla.example.com"
+      }
+    }
+  }
+}
+```
+
+###### **With Visual Studio Code**
+Add this to your `mcp.json`:
+```json
+{
+  "servers": {
+    "bugzilla-local-http": {
+      "type": "http",
+      "url": "http://127.0.0.1:8000/mcp",
+      "headers": {
+        "api_key": "your-api-key-here",
+        "bugzilla_url": "https://bugzilla.example.com"
+      }
+    }
+  }
+}
+```
+
+## Development
+
+```bash
+git clone https://github.com/SanthoshSiddegowda/bugzilla-mcp.git
+cd bugzilla-mcp
+
+# Install dependencies (uv creates the virtual environment)
+uv sync --all-extras
+
+# Run the tests
+uv run pytest tests
+
+# Inspect the server
+uv run fastmcp inspect server.py:mcp
+```
+
+## Deprecations
+
+### API key in the query string (Bugzilla 5.0 / 5.2)
+
+The server sends your API key to Bugzilla in the `X-BUGZILLA-API-KEY` header, which keeps it out of URLs and access logs. Stock Bugzilla **5.0 and 5.2 don't read that header**, so for those instances the server falls back to sending the key as `?api_key=` (the previous behaviour) and logs a deprecation warning.
+
+- **Nothing breaks**: existing setups keep working with no config changes.
+- The server detects support automatically, once per Bugzilla URL, using a probe that never sends your real key.
+- bugzilla.mozilla.org and Bugzilla `master` already use the header.
+- The query-string fallback will be removed once a stable Bugzilla release supports the header. Until then, if your Bugzilla runs 5.0/5.2, make sure its web server and any proxies don't keep query strings in access logs.
+
+## Security Considerations
+
+- Never commit API keys or credentials
+- Use API keys with minimal required permissions
+- Consider implementing rate limiting for production use
+- Use HTTPS for the Bugzilla URL in production
+
+## Security Best Practices
+
+This MCP implementation requires Bugzilla API access to function. For security:
+
+1. **Use a dedicated Bugzilla account**. A Bugzilla API key has the same permissions as the account that created it, so limit the account (group membership, product access) rather than the key
+2. **Never use administrative accounts**
+3. **Be aware the server can write**: the `add_comment` tool posts comments as that account
+4. **Revoke and rotate keys** regularly from `userprefs.cgi?tab=apikey`
+
+⚠️ **IMPORTANT**: Always follow the principle of least privilege when configuring API access.
+
+## Acknowledgments
+
+This project was inspired by [Sai Karthik's mcp-bugzilla](https://kskarthik.gitlab.io/logs/mcp-server-bugzilla/) project. His work on building an MCP server for Bugzilla using FastMCP provided valuable insights and inspiration. Thank you for sharing your experience and contributing to the MCP ecosystem!
+
+## License
+
+Apache 2.0 License - see LICENSE file for details.