qb-mcp 0.1.0__tar.gz

qb_mcp-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,93 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  # -- Class A: offline behaviour tests across supported Python versions ----
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check .
+
+      - name: Type check
+        run: mypy src
+
+      # Fail fast if the interpreter is not the clean shape we think it is
+      # (mcp major version, package resolves to this checkout, test count).
+      - name: Environment gate
+        run: python scripts/env_check.py --env A --no-net --expect-tests 130
+
+      - name: "Class A - offline behaviour"
+        run: pytest -q --ignore=tests/live --cov=qb_mcp --cov-report=term-missing
+
+  # -- Class B: the only job that talks to a real qBittorrent ---------------
+  # Runs on main only. Any failure here means a belief encoded in Class A has
+  # gone stale, so it is not treated as flaky.
+  live:
+    runs-on: ubuntu-latest
+    needs: test
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: pip install -e ".[dev]"
+
+      - name: Start qBittorrent container
+        run: |
+          docker run -d --name qb -p 8080:8080 \
+            qbittorrentofficial/qbittorrent-nox:latest
+          for i in $(seq 90); do
+            code=$(curl -s -o /dev/null -w '%{http_code}' http://127.0.0.1:8080/ || true)
+            if [ -n "$code" ] && [ "$code" != "000" ]; then
+              echo "WebUI answered HTTP $code after ${i}s"
+              break
+            fi
+            sleep 1
+          done
+          echo "--- container log ---"
+          docker logs qb 2>&1 | tail -30
+
+      - name: Resolve temporary password
+        id: qbpass
+        run: |
+          PW=$(docker logs qb 2>&1 \
+               | grep -i "temporary password" \
+               | tail -1 \
+               | sed -E 's/.*session: *//' \
+               | tr -d '\r' | tr -d ' ')
+          if [ -z "$PW" ]; then
+            echo "::error::temporary password not found in container log"
+            docker logs qb 2>&1 | tail -40
+            exit 1
+          fi
+          echo "::add-mask::$PW"
+          echo "value=$PW" >> "$GITHUB_OUTPUT"
+
+      - name: "Class B - live qBittorrent"
+        env:
+          QB_TEST_URL: http://127.0.0.1:8080
+          QB_TEST_USER: admin
+          QB_TEST_PASS: ${{ steps.qbpass.outputs.value }}
+        run: pytest tests/live -q -rs
+
+      - name: Container log on failure
+        if: failure()
+        run: docker logs qb 2>&1 | tail -60

qb_mcp-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+jobs:
+  # A tag can be pushed from an unverified commit, so re-run the checks here
+  # rather than trusting that CI already ran on this exact tree.
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: pip install -e ".[dev]"
+      - name: Lint
+        run: ruff check .
+      - name: Type check
+        run: mypy src
+      - name: Offline tests
+        run: pytest -q --ignore=tests/live
+
+  build:
+    needs: verify
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build sdist and wheel
+        run: |
+          pip install build twine
+          python -m build
+          twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  # Trusted Publishing: no API token is stored anywhere. PyPI verifies the
+  # OIDC identity of this workflow instead.
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

qb_mcp-0.1.0/.gitignore

@@ -0,0 +1,34 @@
+# 凭据（务必保持在最前）
+.instances.json
+.env
+.env.*
+!.env.example
+*.secret
+*.pem
+*.key
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+venv/
+.uv/
+
+# 工具缓存
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# 运行产物
+*.log
+*.sqlite
+*.db
+
+# 系统
+.DS_Store
+Thumbs.db

qb_mcp-0.1.0/CHANGELOG.md

@@ -0,0 +1,73 @@
+# Changelog
+
+All notable changes to this project are documented here.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-11-03
+
+First public release.
+
+### Added
+
+- **11 MCP tools**, grouped by intent rather than by API endpoint:
+  - read: `qb_instances`, `qb_overview`, `qb_list`, `qb_detail`, `qb_diagnose`
+  - write: `qb_control`, `qb_set_limit`, `qb_set_share`, `qb_add`, `qb_remove`,
+    `qb_category`
+- **`qb_diagnose`** explains *why* an instance is or is not uploading instead of
+  dumping raw fields: it checks connection state, tracker health, listening
+  port, peer supply, speed limits and torrent states, then states a verdict.
+- **Arbitrary many instances**, each with its own credentials.
+- **Three password forms**: plain text, `${ENV_VAR}` placeholder, or
+  `{"file": "/path/to/secret"}`.
+- **Two transports**: `stdio` for local MCP clients, `streamable-http` for a
+  network server.
+- Slimmed responses — the raw qBittorrent payloads are trimmed to the fields
+  worth spending context on.
+- Write operations echo the before/after value so the caller can verify the
+  change.
+
+### Fixed
+
+Three behaviours that are not in the qBittorrent documentation and only show up
+against a live instance:
+
+- `Referer` and `Origin` must match the request `Host` **including the port**,
+  otherwise the WebUI rejects the login.
+- A wrong password returns **HTTP 200** with the body `Fails.`. Treating any
+  200 as success turns a bad password into a confusing string of 403s later.
+- A reverse proxy may return **204 with an empty body** on a successful login
+  instead of `200 Ok.`.
+
+Two more issues fixed during bring-up against real instances:
+
+- Cumulative totals (`alltime_ul`, `alltime_dl`, `global_ratio`,
+  `total_peer_connections`) live in `sync/maindata` under `server_state`.
+  `transfer/info` only carries live speeds and rate limits, so reading totals
+  from there returns zeros.
+- `qb_diagnose` treated "a speed limit is configured" as "the speed limit is
+  the bottleneck". It now requires throughput to reach 80 % of the configured
+  cap, and requires at least 10 leechers before blaming peer reachability.
+
+### Security
+
+- `delete_files` defaults to `false`; removing a torrent never deletes data
+  unless explicitly requested.
+- An explicitly configured `.instances.json` path is strict — a typo raises
+  instead of silently falling back to a file in the working directory.
+- The config file's permissions are checked and a warning is printed when it is
+  readable by group or others.
+
+### Testing
+
+- 124 test cases, split into two classes:
+  - **offline behaviour** (118) — no socket ever opened, runs on Python
+    3.10 / 3.11 / 3.12
+  - **live qBittorrent** (6) — a container started by CI, the only path that can
+    tell when an assumption about the real API has gone stale
+- 100 % statement coverage of `qb_mcp` (543 statements).
+- CI also runs an environment gate that fails the build when the interpreter is
+  not the clean shape the tests assume.
+
+[0.1.0]: https://github.com/zxw060810/qb-mcp/releases/tag/v0.1.0

qb_mcp-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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
+      (an example is provided in the Appendix below).
+
+      "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 conspicuously 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

qb_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.5
+Name: qb-mcp
+Version: 0.1.0
+Summary: MCP server for qBittorrent - manage torrents with natural language
+Project-URL: Homepage, https://github.com/zxw060810/qb-mcp
+Project-URL: Issues, https://github.com/zxw060810/qb-mcp/issues
+Project-URL: Changelog, https://github.com/zxw060810/qb-mcp/blob/main/CHANGELOG.md
+Author: zxw060810
+License: Apache-2.0
+License-File: LICENSE
+Keywords: ai,llm,mcp,model-context-protocol,qbittorrent,torrent
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Networking
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: mcp>=1.0
+Requires-Dist: requests>=2.31
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# qb-mcp
+
+**An MCP server for qBittorrent — manage torrents with natural language.**
+
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](pyproject.toml)
+[![MCP](https://img.shields.io/badge/MCP-streamable%20http%20%7C%20stdio-8b5cf6.svg)](https://modelcontextprotocol.io)
+
+> This is an unofficial project. It is not affiliated with, endorsed by, or
+> supported by the qBittorrent project.
+
+**English** | [简体中文](README.zh-CN.md)
+
+`qb-mcp` wraps the qBittorrent WebUI API v2 and exposes it as eleven tools that
+an AI agent can call. It manages **any number of instances**, each with its own
+credentials, so a single agent can drive a home NAS and a remote seedbox at once.
+
+## Why this exists
+
+qBittorrent has a complete HTTP API but no MCP interface. Wrapping it means an
+agent can answer "why isn't it uploading?" by actually checking tracker health,
+listening ports, speed limits and peer supply — instead of guessing.
+
+The eleven tools are grouped by **user intent**, not by API endpoint: mapping all
+80+ endpoints one-to-one would produce a tool list no model can choose from.
+
+## Features
+
+- **Multiple instances**, each with independent credentials
+- **`qb_diagnose`** — turns "why is nothing uploading?" into one call
+- **Field-trimmed responses** — the API returns 30+ fields per torrent; this returns 12
+- **Before/after reporting** on every write operation
+- **`delete_files` is opt-in** — removing a torrent never deletes data by default
+- **stdio and HTTP** transports
+- Credentials never leave your machine; nothing is logged
+
+## Quick start
+
+```bash
+pip install qb-mcp
+cp instances.example.json .instances.json
+# edit .instances.json with your qBittorrent URL and credentials
+chmod 600 .instances.json
+qb-mcp
+```
+
+## Configuration
+
+`qb-mcp` reads `.instances.json` from the current directory, or the path in
+`QB_MCP_CONFIG`.
+
+```json
+{
+  "instances": {
+    "nas": {
+      "label": "Home NAS",
+      "url": "http://192.168.1.100:8080",
+      "username": "admin",
+      "password": "${QB_PASS_NAS}"
+    },
+    "seedbox": {
+      "url": "https://seedbox.example.com",
+      "username": "me",
+      "password": {"file": "~/.secrets/seedbox"}
+    }
+  }
+}
+```
+
+| Field | Required | Default | Notes |
+|---|---|---|---|
+| `url` | ✅ | — | Must start with `http://` or `https://` |
+| `username` | ✅ | — | Per-instance; instances may use different accounts |
+| `password` | ✅ | — | Literal, `"${ENV_VAR}"`, or `{"file": "/path"}` |
+| `label` | — | key | Display name |
+| `verify_ssl` | — | `true` | Set `false` for self-signed certificates |
+| `timeout` | — | `8.0` | Per-request timeout in seconds |
+
+**Keep `.instances.json` out of version control.** It is already listed in
+`.gitignore`. `qb-mcp` prints a warning if the file is readable by group or others.
+
+## Tools
+
+### Read (safe)
+
+| Tool | Purpose |
+|---|---|
+| `qb_instances` | List configured instances and whether each is reachable |
+| `qb_overview` | Global status for one or all instances |
+| `qb_list` | Torrent list with filtering, sorting and a row limit |
+| `qb_detail` | One torrent in depth, including tracker status |
+| `qb_diagnose` | Explain why an instance is or is not uploading |
+
+### Write (state-changing)
+
+| Tool | Purpose |
+|---|---|
+| `qb_control` | `pause` / `resume` / `reannounce` / `force_start` |
+| `qb_set_limit` | Global or per-torrent speed limits |
+| `qb_set_share` | Ratio and seeding-time limits |
+| `qb_add` | Add from magnet, URL or a local `.torrent` (paused by default) |
+| `qb_remove` | Remove torrents; `delete_files` is opt-in |
+| `qb_category` | Assign categories and tags |
+
+## Client setup
+
+**stdio** (Claude Desktop, Cursor, most local clients):
+
+```json
+{
+  "mcpServers": {
+    "qbittorrent": {
+      "command": "qb-mcp",
+      "env": { "QB_MCP_CONFIG": "/absolute/path/to/.instances.json" }
+    }
+  }
+}
+```
+
+**HTTP** (remote or multi-client):
+
+```bash
+qb-mcp --transport http --host 127.0.0.1 --port 17890
+```
+
+```json
+{
+  "servers": {
+    "qbittorrent": {
+      "url": "http://127.0.0.1:17890/mcp",
+      "transport": "streamable_http"
+    }
+  }
+}
+```
+
+## Compatibility
+
+| qBittorrent | WebUI API | Status |
+|---|---|---|
+| 4.x | 2.8+ | Supported |
+| 5.x | 2.11+ | Supported (tested on 5.2.4) |
+
+Both official builds and third-party NAS packages (QNAP QPKG, Synology SPK) work,
+with the proxy quirks below already handled.
+
+## Troubleshooting
+
+### `login rejected (Fails.)`
+
+qBittorrent returns **HTTP 200 even when the password is wrong** — the body is
+`Fails.` instead of `Ok.`. `qb-mcp` inspects the body, so this message means the
+credentials are genuinely wrong.
+
+### Login fails behind a reverse proxy
+
+The official API requires `Referer` or `Origin` to match the request `Host`
+**exactly, including the port**. `qb-mcp` sets both from your configured `url`,
+so make sure `url` uses the same host and port you would type in a browser.
+
+### Works with curl but not through a proxy
+
+Some reverse proxies (QNAP QTS is one) return **`204 No Content` with an empty
+body** on a successful login instead of `200 Ok.`. `qb-mcp` treats any status
+below 400 with an empty or `Ok.` body as success.
+
+### `login blocked - too many failed attempts`
+
+qBittorrent temporarily bans an IP after repeated failures. Wait a few minutes,
+or check the WebUI's ban list.
+
+## Development
+
+```bash
+git clone https://github.com/zxw060810/qb-mcp.git
+cd qb-mcp
+pip install -e ".[dev]"
+ruff check .
+mypy src
+pytest
+```
+
+Tests mock the qBittorrent API; no live instance is required.
+
+## License
+
+[Apache-2.0](LICENSE)