mindzeval 0.1.0__tar.gz

mindzeval-0.1.0/.github/ISSUE_TEMPLATE/feedback.md

@@ -0,0 +1,21 @@
+---
+name: Feedback
+about: Tell us what happened when you ran MindzEval on your agent
+labels: feedback
+---
+
+**Agent:** framework (LangGraph, CrewAI, HTTP service, ...) and adapter used (python / http / outputs)
+
+**Does your agent return:** SQL? rows? status (answer / clarify / decline)?
+
+**Database:** Postgres / SQLite / other
+
+**Time to first score:** roughly how long, and where you got stuck
+
+**Verdicts you think are wrong** (case id, verdict, cause, and why):
+
+**What was confusing or missing:**
+
+**Would you run this in CI?** yes / no / why
+
+<!-- Please don't paste credentials, customer data or full result rows. -->

mindzeval-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## What changed
+
+## Why
+
+## How it was tested
+
+- [ ] `pytest`
+- [ ] `ruff check src tests` and `ruff format --check src tests`
+- [ ] `mypy`
+- [ ] Docs and `CHANGELOG.md` updated if behaviour or interfaces changed
+
+<!-- Never include credentials, client schemas or client data in code, tests or examples. -->

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

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches: [development, main, production]
+  pull_request:
+    branches: [development, main, production]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint and type check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install --upgrade pip
+      - run: pip install -e ".[dev]"
+      - run: ruff check src tests
+      - run: ruff format --check src tests
+      - run: mypy
+
+  test:
+    name: Test (${{ matrix.os }}, Python ${{ matrix.python }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: python -m pip install --upgrade pip
+      - run: pip install -e ".[dev]"
+      - run: pytest
+
+  postgres:
+    name: Test against Postgres
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: mindzeval
+          POSTGRES_PASSWORD: mindzeval
+          POSTGRES_DB: mindzeval
+        ports: ["5432:5432"]
+        options: >-
+          --health-cmd "pg_isready -U mindzeval"
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 10
+    env:
+      MINDZEVAL_TEST_POSTGRES_URL: postgresql://mindzeval:mindzeval@localhost:5432/mindzeval
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install --upgrade pip
+      - run: pip install -e ".[dev,postgres]"
+      - run: pytest tests/test_db.py -v

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

@@ -0,0 +1,36 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  pypi-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mindzeval
+    permissions:
+      id-token: write  # Mandatory for PyPI Trusted Publishing (OIDC)
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: python -m pip install --upgrade pip build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+

mindzeval-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+
+# Tooling
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# MindzEval run output and local secrets
+mindzeval-results/
+.env
+.env.*
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db

mindzeval-0.1.0/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to MindzEval are recorded here. The project follows
+[semantic versioning](https://semver.org/); until `1.0` the public interfaces may change
+between minor versions.
+
+## [0.1.0] - 2026-11-12
+
+### Added
+- **Contracts:** agent result record, case format (single- and multi-turn, six comparison
+  modes, composite keys, expected behaviour, trace assertions, tolerance overrides) and the
+  `mindzeval.yaml` config.
+- **Loading:** YAML / JSON / JSONL / CSV datasets with per-file defaults; every problem
+  reported with file, line and field; `${ENV}` secrets; literal credentials refused.
+- **Agent adapters:** Python function (sync or async, any framework), HTTP endpoint (body
+  templates, response mapping, status translation) and pre-generated outputs; timeouts,
+  retries with backoff, rate limiting and concurrency.
+- **Database layer:** Postgres and SQLite, read-only transactions, statement timeouts, and
+  a SQL guard that refuses anything but a single read query.
+- **Golden validator** (`mindzeval validate`): reference errors, empty results, drift,
+  stability, NULL groups and orphan-inflated answers (declared foreign keys or configured
+  relationships).
+- **Scoring:** set, ordered, scalar, grouped and value-based table comparison with a
+  configurable tolerance policy; precision / recall / F1; replay of the agent's SQL when it
+  returns no rows; uncapped replay to separate display limits from logic errors; behaviour
+  scored in both directions; trace assertions; safety checks (write attempts, forbidden
+  tables, PII); custom scorers; one failure cause per failed turn.
+- **Runs** (`mindzeval run`): filters by tag, case and limit; dry run; matrix runs across
+  models / prompts / any parameter; CSV, JSON and HTML reports; console summary; CI
+  thresholds and exit codes.
+- `mindzeval quickstart`: a runnable example project.
+- Docs: connecting agents, case format, config, result record, reading results, custom
+  scorers, getting-started guide.
+
+### Changed
+- Prepared the repository for public use: the internal alpha guide is now
+  `docs/getting-started.md`, the alpha feedback issue template is now a general feedback
+  template, install instructions use the default branch, and CI also runs on `main`.
+- Documented the `truncated` field of the agent result record.

mindzeval-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 displays 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 2026 MindzKonnected
+
+   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.
+

mindzeval-0.1.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.5
+Name: mindzeval
+Version: 0.1.0
+Summary: Evaluation framework for SQL agents: result-based accuracy, behaviour scoring, multi-turn and golden-answer validation.
+Project-URL: Homepage, https://github.com/MindzKonnected/mindzeval
+Project-URL: Documentation, https://github.com/MindzKonnected/mindzeval#readme
+Project-URL: Repository, https://github.com/MindzKonnected/mindzeval
+Project-URL: Issues, https://github.com/MindzKonnected/mindzeval/issues
+Project-URL: Changelog, https://github.com/MindzKonnected/mindzeval/blob/main/CHANGELOG.md
+Author: MindzKonnected
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,evaluation,llm,sql,testing,text-to-sql
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.7
+Requires-Dist: pyyaml<7,>=6.0
+Requires-Dist: sqlalchemy<3,>=2.0
+Requires-Dist: sqlglot<31,>=30
+Provides-Extra: dev
+Requires-Dist: mypy==2.4.0; extra == 'dev'
+Requires-Dist: pytest==9.1.1; extra == 'dev'
+Requires-Dist: ruff==0.17.1; extra == 'dev'
+Requires-Dist: types-pyyaml==6.0.12.20260906; extra == 'dev'
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary<3,>=2.9; extra == 'postgres'
+Requires-Dist: psycopg[binary]<4,>=3.1; extra == 'postgres'
+Description-Content-Type: text/markdown
+
+# MindzEval
+
+MindzEval proves your SQL agent is accurate and safe before it reaches users, and keeps proving it on every change.
+
+> **Status: release `0.1.0`.** New here? Start with [getting started](docs/getting-started.md). Feedback and bug reports are welcome in the [issues](https://github.com/MindzKonnected/mindzeval/issues).
+
+## What it does
+
+- **Grades the data, not the SQL.** The agent's results are compared with the results of a reference query, so correct SQL written a different way still passes.
+- **Checks the answer key first.** Reference queries are validated against the live database (empty, drift, unstable, NULL groups, orphan-inflated) before any agent is graded.
+- **Scores behaviour both ways.** Asking for clarification or declining is rewarded when it's right and penalised when it isn't.
+- **Separates display limits from logic errors.** The agent's SQL is re-run without its display `LIMIT`, so a UI row cap isn't mistaken for a wrong query.
+- **Checks safety.** Write attempts, forbidden tables and PII in results or answers.
+- **Works with any agent.** LangChain, LangGraph, CrewAI, LlamaIndex, the OpenAI Agents SDK, plain Python, or any HTTP service.
+- **Compares models and prompts.** Matrix runs evaluate every combination side by side.
+- **Read-only by design.** Every query MindzEval runs is parsed and refused unless it is a single read, then executed in a read-only transaction with a timeout.
+
+## Installation
+
+MindzEval requires Python 3.11 or newer:
+
+```bash
+# SQLite only
+pip install mindzeval
+
+# With PostgreSQL support
+pip install "mindzeval[postgres]"
+```
+
+## Quickstart
+
+```bash
+mindzeval quickstart demo
+cd demo
+mindzeval run
+```
+
+The example agent fails some cases on purpose so you can see what each verdict means.
+
+## Your own agent
+
+`mindzeval.yaml`:
+
+```yaml
+project: shop-agent
+agent:
+  type: python
+  target: my_project.eval_adapter:answer     # or type: http with a URL
+database:
+  url: postgresql://reader:${DB_PASSWORD}@db.internal/shop
+datasets: cases/*.yaml
+```
+
+`cases/customers.yaml`:
+
+```yaml
+- id: customers_in_germany
+  question: Which customers are in Germany?
+  reference_sql: SELECT id FROM customers WHERE country = 'DE'
+  key: id
+
+- id: vague_request
+  question: Show me the data
+  expect: {behavior: clarify}
+```
+
+```bash
+mindzeval lint       # check config and cases (no connections, no secrets)
+mindzeval validate   # check reference queries against the database
+mindzeval run        # evaluate; exits 1 if thresholds aren't met
+```
+
+## Documentation
+
+- [Getting started](docs/getting-started.md): install, try the example, connect your agent
+- [Integration examples](https://github.com/MindzKonnected/mindzeval-integration-examples): runnable examples per framework, starting with LangGraph
+- [Connecting your agent](docs/guides/connecting-agents.md): Python, LangGraph, LangChain, CrewAI, HTTP, saved outputs, model comparison
+- [Case format](docs/reference/case-format.md)
+- [Config file](docs/reference/config.md)
+- [Agent result record](docs/reference/agent-response.md)
+- [Reading results](docs/reference/results.md): verdicts, numbers, failure causes, exit codes
+- [Custom scorers](docs/guides/custom-scorers.md)
+
+## Development
+
+```bash
+git clone https://github.com/MindzKonnected/mindzeval.git && cd mindzeval
+python -m venv .venv && .venv\Scripts\activate      # macOS/Linux: source .venv/bin/activate
+pip install -e ".[dev,postgres]"
+pytest              # set MINDZEVAL_TEST_POSTGRES_URL to include Postgres
+ruff check src tests && ruff format --check src tests && mypy
+```
+
+Work happens on `development` through pull requests. `main` is the default branch and `production` holds released versions.
+
+## License
+
+MindzEval is licensed under the [Apache License 2.0](LICENSE).

mindzeval-0.1.0/README.md

@@ -0,0 +1,98 @@
+# MindzEval
+
+MindzEval proves your SQL agent is accurate and safe before it reaches users, and keeps proving it on every change.
+
+> **Status: release `0.1.0`.** New here? Start with [getting started](docs/getting-started.md). Feedback and bug reports are welcome in the [issues](https://github.com/MindzKonnected/mindzeval/issues).
+
+## What it does
+
+- **Grades the data, not the SQL.** The agent's results are compared with the results of a reference query, so correct SQL written a different way still passes.
+- **Checks the answer key first.** Reference queries are validated against the live database (empty, drift, unstable, NULL groups, orphan-inflated) before any agent is graded.
+- **Scores behaviour both ways.** Asking for clarification or declining is rewarded when it's right and penalised when it isn't.
+- **Separates display limits from logic errors.** The agent's SQL is re-run without its display `LIMIT`, so a UI row cap isn't mistaken for a wrong query.
+- **Checks safety.** Write attempts, forbidden tables and PII in results or answers.
+- **Works with any agent.** LangChain, LangGraph, CrewAI, LlamaIndex, the OpenAI Agents SDK, plain Python, or any HTTP service.
+- **Compares models and prompts.** Matrix runs evaluate every combination side by side.
+- **Read-only by design.** Every query MindzEval runs is parsed and refused unless it is a single read, then executed in a read-only transaction with a timeout.
+
+## Installation
+
+MindzEval requires Python 3.11 or newer:
+
+```bash
+# SQLite only
+pip install mindzeval
+
+# With PostgreSQL support
+pip install "mindzeval[postgres]"
+```
+
+## Quickstart
+
+```bash
+mindzeval quickstart demo
+cd demo
+mindzeval run
+```
+
+The example agent fails some cases on purpose so you can see what each verdict means.
+
+## Your own agent
+
+`mindzeval.yaml`:
+
+```yaml
+project: shop-agent
+agent:
+  type: python
+  target: my_project.eval_adapter:answer     # or type: http with a URL
+database:
+  url: postgresql://reader:${DB_PASSWORD}@db.internal/shop
+datasets: cases/*.yaml
+```
+
+`cases/customers.yaml`:
+
+```yaml
+- id: customers_in_germany
+  question: Which customers are in Germany?
+  reference_sql: SELECT id FROM customers WHERE country = 'DE'
+  key: id
+
+- id: vague_request
+  question: Show me the data
+  expect: {behavior: clarify}
+```
+
+```bash
+mindzeval lint       # check config and cases (no connections, no secrets)
+mindzeval validate   # check reference queries against the database
+mindzeval run        # evaluate; exits 1 if thresholds aren't met
+```
+
+## Documentation
+
+- [Getting started](docs/getting-started.md): install, try the example, connect your agent
+- [Integration examples](https://github.com/MindzKonnected/mindzeval-integration-examples): runnable examples per framework, starting with LangGraph
+- [Connecting your agent](docs/guides/connecting-agents.md): Python, LangGraph, LangChain, CrewAI, HTTP, saved outputs, model comparison
+- [Case format](docs/reference/case-format.md)
+- [Config file](docs/reference/config.md)
+- [Agent result record](docs/reference/agent-response.md)
+- [Reading results](docs/reference/results.md): verdicts, numbers, failure causes, exit codes
+- [Custom scorers](docs/guides/custom-scorers.md)
+
+## Development
+
+```bash
+git clone https://github.com/MindzKonnected/mindzeval.git && cd mindzeval
+python -m venv .venv && .venv\Scripts\activate      # macOS/Linux: source .venv/bin/activate
+pip install -e ".[dev,postgres]"
+pytest              # set MINDZEVAL_TEST_POSTGRES_URL to include Postgres
+ruff check src tests && ruff format --check src tests && mypy
+```
+
+Work happens on `development` through pull requests. `main` is the default branch and `production` holds released versions.
+
+## License
+
+MindzEval is licensed under the [Apache License 2.0](LICENSE).