netdryrun 0.1.0__tar.gz

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

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  unit:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.10", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: python -m pip install -e ".[dev]"
+      - run: pytest -q
+
+  e2e:
+    needs: unit
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        example: [frr-bgp, srl-frr]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./
+        with:
+          path: examples/${{ matrix.example }}
+          artifact-name: report-${{ matrix.example }}
+
+  # Proves the tool catches a real mistake: this run MUST fail.
+  catches-bad-change:
+    needs: unit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - id: ndr
+        uses: ./
+        continue-on-error: true
+        with:
+          path: examples/frr-bgp-broken
+          artifact-name: report-frr-bgp-broken
+      - name: Expect failure
+        run: |
+          echo "status=${{ steps.ndr.outputs.status }} failed=${{ steps.ndr.outputs.failed }}"
+          test "${{ steps.ndr.outputs.status }}" = "failed"
+          test "${{ steps.ndr.outputs.failed }}" -ge 1

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

@@ -0,0 +1,58 @@
+name: Release
+
+# Publishes to PyPI with Trusted Publishing (OIDC): no tokens or passwords are stored anywhere.
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Check tag matches package version
+        run: |
+          pkg="$(python -c "import re,pathlib;print(re.search(r'__version__ = \"(.+?)\"', pathlib.Path('src/netdryrun/__init__.py').read_text()).group(1))")"
+          test "v$pkg" = "$GITHUB_REF_NAME" || { echo "tag $GITHUB_REF_NAME != package v$pkg"; exit 1; }
+      - run: python -m pip install --quiet build && python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/netdryrun/
+    permissions:
+      id-token: write   # required for Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+          REPO: ${{ github.repository }}
+        run: gh release create "$TAG" dist/* --repo "$REPO" --title "NetDryRun $TAG" --generate-notes

netdryrun-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.egg-info/
+.venv/
+build/
+dist/
+netdryrun-report.json
+netdryrun-junit.xml
+.pytest_cache/

netdryrun-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

netdryrun-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.5
+Name: netdryrun
+Version: 0.1.0
+Summary: Test network changes before they touch production: real virtual labs, behavioral checks, evidence.
+Project-URL: Homepage, https://netdryrun.com
+Project-URL: Source, https://github.com/netdryrun/netdryrun
+Author: NetDryRun
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: bgp,ci,containerlab,frr,netdevops,network,srlinux,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: System Administrators
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: mcp<3,>=2.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Provides-Extra: mcp
+Requires-Dist: mcp<3,>=2.0; extra == 'mcp'
+Description-Content-Type: text/markdown
+
+# NetDryRun
+
+**Test network changes before they touch production.**
+
+NetDryRun boots your topology as a real virtual network ([containerlab](https://containerlab.dev)), applies your configs, and checks how the network actually *behaves*: BGP sessions, prefix counts, routes, reachability. It catches mistakes like route leaks before they reach production, and leaves evidence a reviewer can trust.
+
+```text
+$ netdryrun run examples/frr-bgp-broken
+Deploying lab ndr-frr-broken (3 nodes)...
+  [PASS] r1: BGP session to 10.0.12.2 is established -- state is established (6.3s)
+  [PASS] r1: prefixes from 10.0.12.2 >= 1 and <= 10 -- 3 ipv4-unicast prefixes accepted (0.1s)
+  [PASS] r1: ping 192.168.3.1 from 192.168.1.1 expects success -- 3/3 replies (2.3s)
+  [FAIL] r1: route 0.0.0.0/0 via bgp is absent -- unexpectedly present via bgp (not selected) (0.1s)
+FAILED: 5 passed, 1 failed (6 checks)
+```
+
+That run caught a leaked default route that was *received but not selected*. A ping test or a config linter would have missed it.
+
+> Status: **v0.1, early.** Works today with FRR and Nokia SR Linux on Linux and WSL2. Feedback and issues are very welcome.
+
+## Why
+
+- **It tests behavior, not syntax.** Linters and config diffs can't tell you whether BGP will come up or whether a prefix leaks. A real control plane can.
+- **It's built for CI.** One GitHub Action, a pass/fail exit code, a Markdown summary in the job, JUnit XML, and a JSON evidence file with every command and raw output.
+- **It doesn't lie about convergence.** Positive checks wait for the network to converge. Negative checks ("this route must be absent") run only after convergence and must hold for a time window, so they can't pass just because BGP hasn't come up yet.
+
+## Quick start
+
+Requirements: Linux or WSL2, Docker, [containerlab](https://containerlab.dev/install/), Python 3.10+.
+
+```bash
+pip install netdryrun
+git clone https://github.com/netdryrun/netdryrun && cd netdryrun
+netdryrun run examples/frr-bgp          # 3 FRR routers, should pass
+netdryrun run examples/srl-frr          # SR Linux + FRR, should pass
+netdryrun run examples/frr-bgp-broken   # a bad change, should fail
+```
+
+## netdryrun.yml
+
+```yaml
+lab: topology.clab.yml      # your containerlab topology
+timeout: 90                 # seconds a positive check may wait for convergence
+
+checks:
+  - type: bgp_session       # session reaches a state (default: established)
+    node: r1
+    neighbor: 10.0.12.2
+  - type: bgp_prefixes      # accepted prefix count within a range
+    node: r1
+    neighbor: 10.0.12.2
+    min: 1
+    max: 10
+  - type: route             # route present (or absent), optionally via a protocol
+    node: r1
+    prefix: 192.168.3.0/24
+    protocol: bgp
+  - type: ping              # reachability, optionally from a source address
+    node: r1
+    source: 192.168.1.1
+    target: 192.168.3.1
+  - type: route             # negative check: must stay absent after convergence
+    node: r1
+    prefix: 0.0.0.0/0
+    protocol: bgp
+    present: false
+```
+
+Every check also accepts `name`, `timeout` and `vrf`. Ping accepts `expect: failure` and `count`. Drivers are detected from the topology; override them with `nodes: {r1: {driver: frr}}`.
+
+| Check | FRR | SR Linux |
+|---|---|---|
+| `bgp_session` | ✅ | ✅ |
+| `bgp_prefixes` (accepted = received minus rejected by policy) | ✅ | ✅ |
+| `route` present / absent | ✅ | ✅ |
+| `ping` success / failure | ✅ | ✅ |
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `netdryrun run [path]` | Deploy the lab, run the checks, destroy the lab. Add `--keep` to leave it up for debugging |
+| `netdryrun check [path]` | Run the checks against a lab that is already running |
+| `netdryrun validate [path]` | Validate `netdryrun.yml` without running anything |
+
+Reports: `--json FILE` (full evidence), `--markdown FILE`, `--junit FILE`. Under GitHub Actions, a summary is appended to the job page automatically. Exit codes: `0` passed, `1` a check failed, `2` config or lab error.
+
+## GitHub Action
+
+```yaml
+name: Network dry run
+on: pull_request
+jobs:
+  dryrun:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: netdryrun/netdryrun@v0.1.0
+        with:
+          path: network/        # folder containing netdryrun.yml
+```
+
+The action installs containerlab, runs the checks, uploads the JSON and JUnit reports as an artifact, and fails the job if any check fails. Outputs: `status`, `passed`, `failed`.
+
+## For AI agents (MCP)
+
+AI agents are starting to change networks. NetDryRun gives them a safety gate: an [MCP](https://modelcontextprotocol.io) server that lets an agent dry-run its change in a real lab and proceed only if every check passes.
+
+```bash
+pip install "netdryrun[mcp]"
+```
+
+Add it to your MCP client (for example Claude Code):
+
+```bash
+claude mcp add netdryrun -- netdryrun-mcp
+```
+
+Tools: `dry_run` (deploy, check, destroy, verdict), `run_checks` (against a running lab), `validate`, `check_types`. Each result carries a separate `verdict` field: `SAFE TO PROCEED` or `DO NOT APPLY THIS CHANGE`.
+
+Safety model:
+- The server **never touches production**. It has no tool that pushes config anywhere; it only builds and tests labs.
+- Tool results contain normalized check results, not raw device output, so text inside a lab (a banner, a route description) can't inject instructions into the agent. Raw evidence goes to the JSON report file.
+- A lab is code: containerlab runs privileged containers. Only point the server at topologies you trust, on a machine you'd let run Docker.
+
+## How it compares
+
+NetDryRun complements these tools; it doesn't replace them.
+
+| Tool | What it does best | Where NetDryRun fits |
+|---|---|---|
+| [Batfish](https://batfish.org) | Static analysis of configs, without booting anything; fast and broad | NetDryRun runs the real control plane, so it sees runtime behavior: convergence, timers, what actually lands in the RIB |
+| [netlab](https://netlab.tools) | Builds labs from a high-level topology, with built-in validation | Use netlab to build the lab and NetDryRun for convergence-aware CI gates and evidence reports |
+| [pyATS / Genie](https://developer.cisco.com/pyats/) | A full test framework with deep Cisco parsers | NetDryRun is a small declarative YAML file plus one GitHub Action, with no test code to write |
+| [containerlab](https://containerlab.dev) | Runs the lab | NetDryRun drives containerlab; it doesn't replace it |
+
+What NetDryRun adds: positive checks wait for convergence, negative checks run only after convergence and must hold, received-but-not-selected routes count as present, and every run produces one pass/fail plus an evidence file.
+
+## Honest limits
+
+- Open-source routers are not your vendor's routers. FRR and SR Linux pass/fail is strong evidence for protocol logic and policy intent, but not proof of vendor-specific behavior. Running your own licensed vendor images is on the roadmap.
+- v0.1 covers IPv4/IPv6 unicast BGP, routes and ping. More checks are coming: OSPF/IS-IS adjacencies, path/traceroute, policy, failure scenarios.
+
+## Roadmap
+
+- **Outage replays:** famous real-world outages (route leaks, mass withdrawals) rebuilt as runnable labs and check packs. Would your change have caused one?
+- Failure scenarios (link down, node down), more check types (OSPF/IS-IS, policy attributes, traceroute) and drivers
+- PR comments with diffs, and signed evidence for change tickets
+
+## License
+
+Apache-2.0

netdryrun-0.1.0/README.md

@@ -0,0 +1,152 @@
+# NetDryRun
+
+**Test network changes before they touch production.**
+
+NetDryRun boots your topology as a real virtual network ([containerlab](https://containerlab.dev)), applies your configs, and checks how the network actually *behaves*: BGP sessions, prefix counts, routes, reachability. It catches mistakes like route leaks before they reach production, and leaves evidence a reviewer can trust.
+
+```text
+$ netdryrun run examples/frr-bgp-broken
+Deploying lab ndr-frr-broken (3 nodes)...
+  [PASS] r1: BGP session to 10.0.12.2 is established -- state is established (6.3s)
+  [PASS] r1: prefixes from 10.0.12.2 >= 1 and <= 10 -- 3 ipv4-unicast prefixes accepted (0.1s)
+  [PASS] r1: ping 192.168.3.1 from 192.168.1.1 expects success -- 3/3 replies (2.3s)
+  [FAIL] r1: route 0.0.0.0/0 via bgp is absent -- unexpectedly present via bgp (not selected) (0.1s)
+FAILED: 5 passed, 1 failed (6 checks)
+```
+
+That run caught a leaked default route that was *received but not selected*. A ping test or a config linter would have missed it.
+
+> Status: **v0.1, early.** Works today with FRR and Nokia SR Linux on Linux and WSL2. Feedback and issues are very welcome.
+
+## Why
+
+- **It tests behavior, not syntax.** Linters and config diffs can't tell you whether BGP will come up or whether a prefix leaks. A real control plane can.
+- **It's built for CI.** One GitHub Action, a pass/fail exit code, a Markdown summary in the job, JUnit XML, and a JSON evidence file with every command and raw output.
+- **It doesn't lie about convergence.** Positive checks wait for the network to converge. Negative checks ("this route must be absent") run only after convergence and must hold for a time window, so they can't pass just because BGP hasn't come up yet.
+
+## Quick start
+
+Requirements: Linux or WSL2, Docker, [containerlab](https://containerlab.dev/install/), Python 3.10+.
+
+```bash
+pip install netdryrun
+git clone https://github.com/netdryrun/netdryrun && cd netdryrun
+netdryrun run examples/frr-bgp          # 3 FRR routers, should pass
+netdryrun run examples/srl-frr          # SR Linux + FRR, should pass
+netdryrun run examples/frr-bgp-broken   # a bad change, should fail
+```
+
+## netdryrun.yml
+
+```yaml
+lab: topology.clab.yml      # your containerlab topology
+timeout: 90                 # seconds a positive check may wait for convergence
+
+checks:
+  - type: bgp_session       # session reaches a state (default: established)
+    node: r1
+    neighbor: 10.0.12.2
+  - type: bgp_prefixes      # accepted prefix count within a range
+    node: r1
+    neighbor: 10.0.12.2
+    min: 1
+    max: 10
+  - type: route             # route present (or absent), optionally via a protocol
+    node: r1
+    prefix: 192.168.3.0/24
+    protocol: bgp
+  - type: ping              # reachability, optionally from a source address
+    node: r1
+    source: 192.168.1.1
+    target: 192.168.3.1
+  - type: route             # negative check: must stay absent after convergence
+    node: r1
+    prefix: 0.0.0.0/0
+    protocol: bgp
+    present: false
+```
+
+Every check also accepts `name`, `timeout` and `vrf`. Ping accepts `expect: failure` and `count`. Drivers are detected from the topology; override them with `nodes: {r1: {driver: frr}}`.
+
+| Check | FRR | SR Linux |
+|---|---|---|
+| `bgp_session` | ✅ | ✅ |
+| `bgp_prefixes` (accepted = received minus rejected by policy) | ✅ | ✅ |
+| `route` present / absent | ✅ | ✅ |
+| `ping` success / failure | ✅ | ✅ |
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `netdryrun run [path]` | Deploy the lab, run the checks, destroy the lab. Add `--keep` to leave it up for debugging |
+| `netdryrun check [path]` | Run the checks against a lab that is already running |
+| `netdryrun validate [path]` | Validate `netdryrun.yml` without running anything |
+
+Reports: `--json FILE` (full evidence), `--markdown FILE`, `--junit FILE`. Under GitHub Actions, a summary is appended to the job page automatically. Exit codes: `0` passed, `1` a check failed, `2` config or lab error.
+
+## GitHub Action
+
+```yaml
+name: Network dry run
+on: pull_request
+jobs:
+  dryrun:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: netdryrun/netdryrun@v0.1.0
+        with:
+          path: network/        # folder containing netdryrun.yml
+```
+
+The action installs containerlab, runs the checks, uploads the JSON and JUnit reports as an artifact, and fails the job if any check fails. Outputs: `status`, `passed`, `failed`.
+
+## For AI agents (MCP)
+
+AI agents are starting to change networks. NetDryRun gives them a safety gate: an [MCP](https://modelcontextprotocol.io) server that lets an agent dry-run its change in a real lab and proceed only if every check passes.
+
+```bash
+pip install "netdryrun[mcp]"
+```
+
+Add it to your MCP client (for example Claude Code):
+
+```bash
+claude mcp add netdryrun -- netdryrun-mcp
+```
+
+Tools: `dry_run` (deploy, check, destroy, verdict), `run_checks` (against a running lab), `validate`, `check_types`. Each result carries a separate `verdict` field: `SAFE TO PROCEED` or `DO NOT APPLY THIS CHANGE`.
+
+Safety model:
+- The server **never touches production**. It has no tool that pushes config anywhere; it only builds and tests labs.
+- Tool results contain normalized check results, not raw device output, so text inside a lab (a banner, a route description) can't inject instructions into the agent. Raw evidence goes to the JSON report file.
+- A lab is code: containerlab runs privileged containers. Only point the server at topologies you trust, on a machine you'd let run Docker.
+
+## How it compares
+
+NetDryRun complements these tools; it doesn't replace them.
+
+| Tool | What it does best | Where NetDryRun fits |
+|---|---|---|
+| [Batfish](https://batfish.org) | Static analysis of configs, without booting anything; fast and broad | NetDryRun runs the real control plane, so it sees runtime behavior: convergence, timers, what actually lands in the RIB |
+| [netlab](https://netlab.tools) | Builds labs from a high-level topology, with built-in validation | Use netlab to build the lab and NetDryRun for convergence-aware CI gates and evidence reports |
+| [pyATS / Genie](https://developer.cisco.com/pyats/) | A full test framework with deep Cisco parsers | NetDryRun is a small declarative YAML file plus one GitHub Action, with no test code to write |
+| [containerlab](https://containerlab.dev) | Runs the lab | NetDryRun drives containerlab; it doesn't replace it |
+
+What NetDryRun adds: positive checks wait for convergence, negative checks run only after convergence and must hold, received-but-not-selected routes count as present, and every run produces one pass/fail plus an evidence file.
+
+## Honest limits
+
+- Open-source routers are not your vendor's routers. FRR and SR Linux pass/fail is strong evidence for protocol logic and policy intent, but not proof of vendor-specific behavior. Running your own licensed vendor images is on the roadmap.
+- v0.1 covers IPv4/IPv6 unicast BGP, routes and ping. More checks are coming: OSPF/IS-IS adjacencies, path/traceroute, policy, failure scenarios.
+
+## Roadmap
+
+- **Outage replays:** famous real-world outages (route leaks, mass withdrawals) rebuilt as runnable labs and check packs. Would your change have caused one?
+- Failure scenarios (link down, node down), more check types (OSPF/IS-IS, policy attributes, traceroute) and drivers
+- PR comments with diffs, and signed evidence for change tickets
+
+## License
+
+Apache-2.0