boaviztapi-mcp 0.1.0__tar.gz

boaviztapi_mcp-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+htmlcov/
+.DS_Store

boaviztapi_mcp-0.1.0/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Added
+
+- MCP server for BoaviztAPI over stdio with eight read-only tools:
+  `list_impact_criteria`, `search_catalog`, `describe_catalog_item`,
+  `estimate_cloud_instance`, `estimate_server`, `estimate_component`,
+  `estimate_device` and `compare_estimates`.
+- Structured results with a plain-text summary: units, min to max ranges, per-phase
+  warnings, assumptions, notes and the BoaviztAPI version used.
+- Local validation of criteria, locations, cloud regions and names before any call.
+- Per-criterion fallback when BoaviztAPI returns 500 for a multi-criteria request.
+- Caching, a concurrency limit and retries for transient failures.
+- Configuration through `BOAVIZTAPI_URL`, `BOAVIZTAPI_TIMEOUT`,
+  `BOAVIZTAPI_DEFAULT_CRITERIA` and `BOAVIZTAPI_CACHE_TTL`.
+- Dockerfile, MCP Registry `server.json` and Glama `glama.json`.
+- MCP specification 2026-07-28 (stateless, `server/discover`) with fallback to the
+  2025-11-25 handshake; tool titles, a server description, and a cacheable tool list.
+- Documentation: README with privacy, limitations and troubleshooting sections, a
+  generated tool reference (`docs/tools.md`), contributing guide and security policy.
+
+[Unreleased]: https://github.com/malikmalikayesha/boaviztapi-mcp/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/malikmalikayesha/boaviztapi-mcp/releases/tag/v0.1.0

boaviztapi_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.
+

boaviztapi_mcp-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+boaviztapi-mcp
+Copyright 2026 malikmalikayesha and contributors
+
+This project is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+It is an independent HTTP client for BoaviztAPI (https://github.com/Boavizta/boaviztapi),
+which is developed by Boavizta and licensed under the GNU Affero General Public License v3.0.
+No BoaviztAPI code or data is bundled with this project. The JSON files under
+tests/fixtures/ are responses recorded from a running BoaviztAPI instance and are
+used only as test data. All impact figures returned by this server are computed by
+BoaviztAPI.
+
+This is an unofficial community project and is not endorsed by Boavizta.

boaviztapi_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.5
+Name: boaviztapi-mcp
+Version: 0.1.0
+Summary: MCP server that lets AI assistants estimate the environmental footprint of cloud instances, servers, components and devices with BoaviztAPI
+Project-URL: Homepage, https://github.com/malikmalikayesha/boaviztapi-mcp
+Project-URL: Issues, https://github.com/malikmalikayesha/boaviztapi-mcp/issues
+Project-URL: Changelog, https://github.com/malikmalikayesha/boaviztapi-mcp/blob/main/CHANGELOG.md
+Author: malikmalikayesha
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: boavizta,boaviztapi,carbon,green-it,lca,mcp,model-context-protocol,sustainability
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx2>=2.14
+Requires-Dist: mcp<3,>=2.3
+Requires-Dist: pydantic>=2.12
+Description-Content-Type: text/markdown
+
+# boaviztapi-mcp
+
+[![CI](https://github.com/malikmalikayesha/boaviztapi-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/malikmalikayesha/boaviztapi-mcp/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/boaviztapi-mcp)](https://pypi.org/project/boaviztapi-mcp/)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+<!-- mcp-name: io.github.malikmalikayesha/boaviztapi-mcp -->
+
+An [MCP](https://modelcontextprotocol.io) server that lets AI assistants answer questions about the environmental footprint of IT hardware: cloud instances, servers, GPUs and other components, and end-user devices. It asks [BoaviztAPI](https://github.com/Boavizta/boaviztapi) and reports the answer with units, uncertainty ranges and caveats.
+
+> Unofficial community project. Every number comes from BoaviztAPI, built by [Boavizta](https://boavizta.org). See their [methodology documentation](https://doc.api.boavizta.org) for how impacts are computed.
+
+## Quick start
+
+You need [uv](https://docs.astral.sh/uv/). The server talks to the public BoaviztAPI instance by default; see [Configuration](#configuration) to use your own.
+
+**Claude Desktop, Cursor and other clients with an `mcpServers` config:**
+
+```json
+{
+  "mcpServers": {
+    "boaviztapi": {
+      "command": "uvx",
+      "args": ["boaviztapi-mcp"]
+    }
+  }
+}
+```
+
+To use your own BoaviztAPI instance, add `"env": {"BOAVIZTAPI_URL": "http://localhost:5000"}` next to `args`.
+
+**Claude Code:**
+
+```bash
+claude mcp add boaviztapi -- uvx boaviztapi-mcp
+```
+
+Add `-e BOAVIZTAPI_URL=http://localhost:5000` before `--` to use your own instance.
+
+**Docker**, from a clone of this repository:
+
+```bash
+docker build -t boaviztapi-mcp .
+docker run -i --rm boaviztapi-mcp
+```
+
+Pass `-e BOAVIZTAPI_URL=...` to `docker run` to change the instance. Inside a container, `localhost` is the container itself; use `host.docker.internal` (Docker Desktop) to reach an instance on your machine.
+
+**From source**, without installing a release:
+
+```bash
+uvx --from git+https://github.com/malikmalikayesha/boaviztapi-mcp boaviztapi-mcp
+```
+
+**Try it without a client** using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector):
+
+```bash
+npx @modelcontextprotocol/inspector uvx boaviztapi-mcp
+```
+
+## What you can ask
+
+- "What is the footprint of 4 H100 SXM GPUs running for a year in Germany?"
+- "Compare an AWS m5.xlarge in France and in the US over a month."
+- "What is the embedded carbon of a typical laptop?"
+- "Which is greener in eu-west-3 at 50% load: m5.xlarge or c5.2xlarge?"
+- "What would a server with 2x Xeon Gold 6134 and 384 GB RAM emit over 5 years in France?"
+- "What does `adp` mean and what unit is it in?"
+
+A real answer to the first question (the `summary` field of `estimate_component`):
+
+```
+4x NVIDIA H100 SXM 80GB, over 8760 h (1 year), in Germany (DEU)
+Embedded = the share of manufacturing allocated to 8760 h of a 26280 h lifetime.
+gwp, Total climate change (kgCO2eq):
+  embedded: 766.8
+  use: 7100 (range 1035 to 10350)
+  total: 7867 (range 1802 to 11120)
+adp, Use of minerals and fossil ressources (kgSbeq):
+  embedded: 0.007776
+  use: 0.0015 (range 0.0002155 to 0.002155)
+  total: 0.009276 (range 0.007992 to 0.009931)
+pe, Consumption of primary energy (MJ):
+  embedded: 10550
+  use: 270000 (range 39880 to 398800)
+  total: 280600 (range 50430 to 409400)
+Assumptions: units 4, TDP 700 W, average power 479.5 W (range 70 to 700), load 65 % (range 0 to 100), use time ratio 1, lifetime 26280 hours, grid carbon intensity 0.422 kg CO2eq/kWh.
+Note: GPU 'h100 sxm' was read as NVIDIA H100 SXM 80GB.
+Note: GPU only; the host server is not included. Use estimate_server with a gpu block for a whole system.
+Source: BoaviztAPI 2.6.0 at https://api.boavizta.org
+```
+
+A comparison (`compare_estimates`, first criterion shown):
+
+```
+Comparison over 8760 h (1 year):
+- m5.xlarge: aws m5.xlarge, over 8760 h (1 year), in eu-west-3 (FRA)
+- c5.2xlarge: aws c5.2xlarge, over 8760 h (1 year), in eu-west-3 (FRA)
+gwp (kgCO2eq):
+  m5.xlarge: total 27.4 (range 22.14 to 36.68)
+  c5.2xlarge: total 61 (range 51.06 to 77.16), +122.6% vs m5.xlarge
+  Lowest: m5.xlarge (ranges do not overlap).
+```
+
+## Tools
+
+All tools are read-only and carry the matching annotations and a display title. Each returns structured content (with an output schema) plus a plain-text `summary`.
+
+The server speaks the current MCP specification, [2026-07-28](https://modelcontextprotocol.io/specification/2026-07-28) (stateless, with `server/discover`), and still accepts the `2025-11-25` handshake used by older clients. It uses none of the features deprecated in 2026-07-28 (logging, sampling, roots).
+
+| Tool | What it does | Key inputs |
+|---|---|---|
+| `list_impact_criteria` | Explains impact criteria codes and units | `query` |
+| `search_catalog` | Finds exact names before estimating | `kind` (cloud_provider, cloud_instance, cloud_region, server_archetype, device_archetype, gpu, cpu, country), `query`, `provider`, `device_type` |
+| `describe_catalog_item` | Shows what an instance, archetype, GPU or CPU contains | `kind`, `name` |
+| `estimate_cloud_instance` | Footprint of one cloud VM | `provider`, `instance_type`, `region` or `usage_location`, `load_percent` |
+| `estimate_server` | Footprint of an on-premise server, optionally with GPUs | `archetype`, `cpu`, `ram`, `disks`, `gpu`, usage fields |
+| `estimate_component` | Footprint of one GPU, CPU, RAM module, SSD or HDD | `component`, `name`, `units`, `capacity_gb` |
+| `estimate_device` | Footprint of a laptop, phone, monitor, IoT device and 9 other types | `device_type`, `archetype` |
+| `compare_estimates` | Ranks 2 to 5 options over the same period | `items`, `duration_hours` |
+
+The estimate tools also take `duration_hours`, `usage_location`, `criteria` (default `gwp`, `adp`, `pe`) and `detail` (`summary` or `breakdown`). Every parameter, type and default is listed in the [tool reference](docs/tools.md).
+
+Names are matched carefully. "h100 sxm" finds "NVIDIA H100 SXM 80GB", and the result notes the interpretation. A name that could mean several items ("h100") or only partly matches one is refused with a list of candidates, so a missing item is never silently swapped for a similar one.
+
+## Reading the results
+
+- **Embedded vs use.** Embedded is manufacturing (and transport where modelled); use is the electricity consumed. They are always reported separately, with a total only when both are numbers.
+- **Period.** Without `duration_hours`, figures cover the whole hardware lifetime. With it, embedded is the share of manufacturing for that period and use is the energy for that period. If the period is longer than the lifetime, BoaviztAPI counts manufacturing once; the result says so.
+- **Ranges.** `(range a to b)` is BoaviztAPI's min and max. When two options' ranges overlap, `compare_estimates` says the ranking is not certain.
+- **Location.** Use-phase impacts depend on the electricity mix. Without a location BoaviztAPI uses a European default with a wide range, and the result suggests passing a country.
+- **"not available from BoaviztAPI for this item"** means there is no data for that criterion and phase. It is never a zero.
+- **Warnings** such as "End of life is not included in the calculation" stay next to the phase they belong to.
+
+## Configuration
+
+| Variable | Default | Meaning |
+|---|---|---|
+| `BOAVIZTAPI_URL` | `https://api.boavizta.org` | BoaviztAPI base URL |
+| `BOAVIZTAPI_TIMEOUT` | `20` | Seconds per request |
+| `BOAVIZTAPI_DEFAULT_CRITERIA` | `gwp,adp,pe` | Criteria used when a call names none |
+| `BOAVIZTAPI_CACHE_TTL` | `86400` | Seconds to cache list and lookup responses; `0` disables caching |
+
+### Self-host BoaviztAPI for regular use
+
+The public instance is a demo. For anything beyond occasional questions, run your own:
+
+```bash
+docker run -p 5000:5000 ghcr.io/boavizta/boaviztapi:latest
+```
+
+then set `BOAVIZTAPI_URL=http://localhost:5000` in the server's environment. The server is polite either way: it identifies itself in the `User-Agent`, caches lists and recent estimates, sends at most four requests at a time, and retries only transient failures.
+
+## Upstream behaviour this server works around
+
+Found while building this against BoaviztAPI 2.6.0. Each one has a live test that will start failing (on purpose) when upstream changes it.
+
+- Unknown criteria and `criteria=all` return HTTP 500, so criteria are checked locally and `all` is refused.
+- Unknown locations and cloud regions are accepted without an error and give generic results, so both are checked against the API's own lists.
+- `name_to_gpu` silently picks one GPU for an ambiguous name and returns 200 with a plain string when nothing matches, so names are resolved here and ambiguous ones are refused.
+- An `iot_device` without an archetype reports 0 for manufacturing, so an archetype is required.
+- The GPU endpoint returns 500 for some criteria on the public instance (fixed upstream in [Boavizta/boaviztapi#621](https://github.com/Boavizta/boaviztapi/pull/621), not yet deployed). A failing multi-criteria request is retried one criterion at a time, and only the failing criteria are marked as errors.
+
+## Privacy
+
+The server sends BoaviztAPI only what the tool call contains: hardware names and specifications, locations, durations and criteria. Requests go to `BOAVIZTAPI_URL` and nowhere else, with a `User-Agent` naming this package. There is no telemetry and nothing is written to disk; caches live in memory and end with the process. Logs go to stderr.
+
+## Limitations
+
+- Figures are BoaviztAPI's model estimates, with ranges that can be wide. Treat them as orders of magnitude for comparing options, not as measurements.
+- A cloud instance's footprint is its share of the host server; networking, storage services and data centre overheads beyond BoaviztAPI's model are not included.
+- Not exposed yet: custom electricity factors, workload time series, standalone motherboards, power supplies and cases, IoT functional blocks, and CPU consumption profiles.
+- The public BoaviztAPI instance is a demo without guaranteed availability. Self-host for anything regular.
+
+## Troubleshooting
+
+| Symptom | What to do |
+|---|---|
+| "BoaviztAPI ... did not respond" | The instance is down or slow. Raise `BOAVIZTAPI_TIMEOUT`, or self-host and set `BOAVIZTAPI_URL`. |
+| "Unknown GPU / CPU / instance type / location ..." | The message lists close matches. Use `search_catalog` to find the exact name. |
+| "... matches N names" | The name is ambiguous; pick one of the listed exact names. |
+| "BoaviztAPI failed (HTTP 500) for: ..." | Upstream cannot compute that criterion for this item. Other criteria are still returned. |
+| Numbers differ from another BoaviztAPI front end | Check the BoaviztAPI version in the result's last line; methods and data change between releases. |
+| The client shows no tools | Run `uvx boaviztapi-mcp --version` in a terminal to check it starts, then look at the client's MCP log. |
+
+## Development
+
+```bash
+uv sync
+uv run pytest                 # unit and tool tests, replaying recorded responses
+uv run ruff check . && uv run ruff format --check . && uv run pyright
+```
+
+- **Recorded responses** live in `tests/fixtures/`. Re-record them after a BoaviztAPI release with `uv run python scripts/record_fixtures.py --clean` and review the diff.
+- **Summaries** are checked against `tests/golden/`; regenerate them with `UPDATE_GOLDEN=1 uv run pytest tests/unit/test_formatting.py`.
+- **Live tests** run against a real instance: start the Docker image above, then `BOAVIZTAPI_URL=http://localhost:5000 uv run pytest -m live -rxX`.
+- **Tool reference**: `docs/tools.md` is generated from the tool schemas with `uv run python scripts/gen_tool_docs.py`; a test fails if it is out of date.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Security issues: see [SECURITY.md](SECURITY.md).
+
+## License
+
+Apache-2.0. BoaviztAPI itself is AGPL-3.0 and is not bundled; see [NOTICE](NOTICE).