metric-contracts 0.1.0__tar.gz

metric_contracts-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+examples/saas/saas.duckdb
+*.duckdb.wal
+.DS_Store
+docs/reports/

metric_contracts-0.1.0/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 0.1.0 - 2026-11-08
+
+- Contract schema (standalone file + Apache Ossie `custom_extensions` payload), JSON Schema 2020-12 committed under `schema/`.
+- `validate`: rules V00-V15.
+- `plan`: allowed/denied with reason, aggregation plan, DuckDB reference SQL (P01-P06).
+- `chart-check`: chart meaning gate (C01-C14).
+- `decompose-check`: driver breakdown must sum to the change (D01-D06).
+- `import dbt`, `import ossie`, `export ossie`.
+- MCP server: `list_metrics`, `get_contract`, `plan_query`, `check_chart`, `check_decomposition`, `list_dimensions`, `validate_contracts`.
+- Example contracts for a fictional subscription SaaS, synthetic DuckDB data, offline before/after demo.
+- GitHub Action `val-ye/metric-contracts@v0`.

metric_contracts-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.

metric_contracts-0.1.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.5
+Name: metric-contracts
+Version: 0.1.0
+Summary: One governed metric contract, many consumers: validator CLI, MCP server, chart meaning gate, decomposition check.
+Project-URL: Homepage, https://github.com/val-ye/metric-contracts
+Project-URL: Issues, https://github.com/val-ye/metric-contracts/issues
+Project-URL: Schema, https://github.com/val-ye/metric-contracts/blob/main/schema/metric-contract.schema.json
+Author: Val Ye
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: additivity,analytics-engineering,data-contracts,mcp,metrics,semantic-layer
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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 :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: jsonschema>=4.23
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: all
+Requires-Dist: anthropic>=0.40; extra == 'all'
+Requires-Dist: duckdb>=1.3; extra == 'all'
+Requires-Dist: mcp>=2.3; extra == 'all'
+Provides-Extra: demo
+Requires-Dist: duckdb>=1.3; extra == 'demo'
+Provides-Extra: dev
+Requires-Dist: anthropic>=0.40; extra == 'dev'
+Requires-Dist: duckdb>=1.3; extra == 'dev'
+Requires-Dist: mcp>=2.3; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: types-jsonschema; extra == 'dev'
+Requires-Dist: types-pyyaml; extra == 'dev'
+Provides-Extra: live
+Requires-Dist: anthropic>=0.40; extra == 'live'
+Provides-Extra: mcp
+Requires-Dist: mcp>=2.3; extra == 'mcp'
+Description-Content-Type: text/markdown
+
+# metric-contracts
+
+<!-- mcp-name: io.github.val-ye/metric-contracts -->
+
+One governed metric contract, many consumers.
+
+A metric contract declares what a semantic layer usually leaves implicit: formula, components,
+source, refresh cadence, as-of semantics, allowed dimensions, **additivity** (additive,
+semi-additive with the non-additive dimension named, or non-additive), caveats, owner.
+Four consumers enforce it:
+
+1. **Validator CLI for CI.** A semi-additive metric must name its non-additive dimension or the
+   build fails. Allowed-dimension sets must be subsets of the declared registry. Ratios must
+   carry components. Every metric needs an owner, a refresh cadence and as-of semantics.
+2. **MCP server.** `list_metrics`, `get_contract`, `plan_query(metric, grain, dimensions)` returns
+   allowed or denied with the reason, so an agent reads the contract before it writes SQL.
+3. **Chart meaning gate.** Given a proposed chart, return veto or allow with the rule that fired:
+   ratios are not stacked, pie'd or summed; semi-additive at a coarse grain takes LAST; pie
+   category cap; funnels only for ordered stages; no duplicate axis values. The model proposes,
+   the rules veto.
+4. **Decomposition check.** A driver/drag breakdown must sum back to the total change, partition
+   one dimension, and state its method for ratios. Otherwise the "insight" is rejected.
+
+Vocabulary follows [Apache Ossie discussion #465](https://github.com/apache/ossie/discussions/465)
+(`additivity`, `non_additive_dimensions[{field, window}]`), and the contract ships both as a
+standalone YAML file and as an Ossie `custom_extensions` payload. Design notes and the survey of
+what dbt, Cube, Malloy, LookML, Rill, Snowflake, Databricks and others already support are in
+[docs/design.md](docs/design.md).
+
+## Install in two minutes
+
+```bash
+pip install "metric-contracts[all]"          # CLI + MCP server + DuckDB demo
+git clone https://github.com/val-ye/metric-contracts && cd metric-contracts
+
+metric-contracts validate examples/saas       # 0 errors
+metric-contracts plan active_subscribers --grain month --dims plan -c examples/saas
+metric-contracts plan active_subscribers --grain month --dims plan --agg sum -c examples/saas   # denied, P04
+python demo/before_after.py                   # the before/after agent demo, offline
+```
+
+Python 3.11 or newer. The core package depends on pydantic, PyYAML and jsonschema only. The
+`mcp`, `demo` and `live` extras add the MCP SDK, DuckDB and the Anthropic SDK.
+
+## A contract
+
+```yaml
+contract_version: "0.1"
+domain: subscriptions
+owner: { team: analytics-engineering, contact: analytics-eng@example.com }
+dimensions:
+  - { name: date, type: time, grains: [day, week, month] }
+  - { name: plan, type: categorical, values: [free, starter, pro, enterprise] }
+metrics:
+  - name: active_subscribers
+    kind: measure
+    formula: count(subscription_id)
+    source: { table: fct_subscriber_snapshot_daily, grain: [date, subscription_id], time_dimension: date }
+    additivity: semi_additive
+    non_additive_dimensions:
+      - { field: date, window: last }
+    dimensions: { allowed: [date, plan, region], time_grains: [day, week, month] }
+    refresh: { cadence: daily, lands_at: "06:00Z", settling_window: P1D }
+    as_of: { semantics: snapshot, snapshot_at: end_of_day }
+    caveats:
+      - A month-end figure is the last daily snapshot, never a sum of days.
+```
+
+The full example with an additive measure, a semi-additive snapshot, a non-additive ratio and a
+distinct count is in [examples/saas](examples/saas/subscriptions.contract.yaml). The JSON Schema
+is committed under [schema/](schema/) and regenerated from the pydantic models in CI.
+
+## Before and after
+
+`python demo/before_after.py` seeds a synthetic DuckDB database and asks two scripted agents the
+same question: total active subscribers by month for Q1, split by plan. Measured output of the
+committed seed:
+
+- Agent A has only the table name. It writes `COUNT(subscription_id) ... GROUP BY month` over a
+  daily snapshot table and reports a total 23.3x the month-end truth.
+- Agent B calls `plan_query` first, receives `{"date": "last", "plan": "sum"}` and a reference
+  query, and matches the month-end truth row for row.
+- Agent B then asks to SUM across months and is denied with
+  `P04_sum_over_non_additive_dim: active_subscribers is semi-additive over date`.
+
+`python demo/before_after.py --live` runs the same two prompts through a real model with
+`plan_query` exposed as a tool (needs `ANTHROPIC_API_KEY` and the `live` extra) and prints the SQL
+each one wrote.
+
+## MCP server
+
+```bash
+metric-contracts serve -c examples/saas            # stdio
+metric-contracts serve -c examples/saas --http     # streamable-http on 127.0.0.1:8765
+```
+
+Claude Desktop / Claude Code config:
+
+```json
+{ "mcpServers": { "metric-contracts": { "command": "metric-contracts", "args": ["serve", "-c", "/path/to/contracts"] } } }
+```
+
+Tools: `list_metrics`, `get_contract`, `plan_query`, `check_chart`, `check_decomposition`,
+`list_dimensions`, `validate_contracts`. Resources: `contract://schema`,
+`contract://schema/payload`, `contract://{domain}`. The server's instructions tell the agent to
+plan before it queries and to treat a denial as an answer, not an obstacle.
+
+## CI
+
+```yaml
+- uses: val-ye/metric-contracts@v0
+  with:
+    paths: contracts/
+```
+
+Or `pipx run metric-contracts validate contracts/ --format github`. Exit code 1 on any error;
+findings are emitted as GitHub annotations.
+
+## Rules
+
+Every rule names the contract field it reads, so a veto is explainable and testable.
+
+| Family | Ids | What they check |
+|---|---|---|
+| Validate | V00-V15 | schema, semi-additive names its dimension, allowed dims in registry, grains, ratio components, distinct count non-additive, source or components, owner, refresh, as-of, dangling components, ordinal funnel dims, unique names, no TODO markers |
+| Plan | P01-P06 | unknown metric, dimension not allowed, grain not allowed, sum over the non-additive dimension, ratio aggregated directly, distinct count rolled up |
+| Chart | C01-C14 | ratio stacked / pie'd / summed, semi-additive at coarse grain takes the declared window, semi-additive stacked over time, distinct count summed, pie cap, pie needs additive, funnel needs ordinal stages, duplicate axis values, dimension and grain allowed, settling window unmarked, series density |
+| Decompose | D01-D06 | sums to total within tolerance, one partition, partition allowed, ratio needs a method, semi-additive deltas are last-to-last, residual disclosed and bounded |
+
+Full tables with the field each rule reads: [docs/design.md](docs/design.md).
+
+## Interop
+
+```bash
+metric-contracts import dbt target/semantic_manifest.json --out contracts/   # stubs with TODO markers
+metric-contracts import ossie model.yaml --out contracts/
+metric-contracts export ossie -c contracts/ --out model.ossie.yaml           # payload in custom_extensions
+```
+
+The dbt importer maps `non_additive_dimension.window_choice` `max` to `last` and `min` to
+`first`, `count_distinct` to a non-additive distinct count, ratio metrics to `components`.
+Refresh, as-of, owner and allowed dimensions are never inferred; they come back as `TODO` and
+`validate` fails until a human declares them.
+
+## What this is not
+
+metric-contracts is not a query engine, not a semantic layer, and not a replacement for dbt,
+Cube, MetricFlow, Malloy or LookML. It does not compute metrics. It holds the declarations those
+tools leave implicit, checks them in CI, and hands them to agents, chart builders and insight
+generators so the rules are enforced where the mistakes happen. The reference SQL `plan` emits
+is a DuckDB illustration of the aggregation plan, not a dialect-aware compiler.
+
+## Development
+
+```bash
+uv venv && uv pip install -e ".[dev]"
+pytest
+ruff check src tests demo examples && mypy
+metric-contracts schema --write schema      # regenerate after a model change
+```
+
+Apache-2.0. Everything in `examples/` is synthetic.

metric_contracts-0.1.0/README.md

@@ -0,0 +1,162 @@
+# metric-contracts
+
+<!-- mcp-name: io.github.val-ye/metric-contracts -->
+
+One governed metric contract, many consumers.
+
+A metric contract declares what a semantic layer usually leaves implicit: formula, components,
+source, refresh cadence, as-of semantics, allowed dimensions, **additivity** (additive,
+semi-additive with the non-additive dimension named, or non-additive), caveats, owner.
+Four consumers enforce it:
+
+1. **Validator CLI for CI.** A semi-additive metric must name its non-additive dimension or the
+   build fails. Allowed-dimension sets must be subsets of the declared registry. Ratios must
+   carry components. Every metric needs an owner, a refresh cadence and as-of semantics.
+2. **MCP server.** `list_metrics`, `get_contract`, `plan_query(metric, grain, dimensions)` returns
+   allowed or denied with the reason, so an agent reads the contract before it writes SQL.
+3. **Chart meaning gate.** Given a proposed chart, return veto or allow with the rule that fired:
+   ratios are not stacked, pie'd or summed; semi-additive at a coarse grain takes LAST; pie
+   category cap; funnels only for ordered stages; no duplicate axis values. The model proposes,
+   the rules veto.
+4. **Decomposition check.** A driver/drag breakdown must sum back to the total change, partition
+   one dimension, and state its method for ratios. Otherwise the "insight" is rejected.
+
+Vocabulary follows [Apache Ossie discussion #465](https://github.com/apache/ossie/discussions/465)
+(`additivity`, `non_additive_dimensions[{field, window}]`), and the contract ships both as a
+standalone YAML file and as an Ossie `custom_extensions` payload. Design notes and the survey of
+what dbt, Cube, Malloy, LookML, Rill, Snowflake, Databricks and others already support are in
+[docs/design.md](docs/design.md).
+
+## Install in two minutes
+
+```bash
+pip install "metric-contracts[all]"          # CLI + MCP server + DuckDB demo
+git clone https://github.com/val-ye/metric-contracts && cd metric-contracts
+
+metric-contracts validate examples/saas       # 0 errors
+metric-contracts plan active_subscribers --grain month --dims plan -c examples/saas
+metric-contracts plan active_subscribers --grain month --dims plan --agg sum -c examples/saas   # denied, P04
+python demo/before_after.py                   # the before/after agent demo, offline
+```
+
+Python 3.11 or newer. The core package depends on pydantic, PyYAML and jsonschema only. The
+`mcp`, `demo` and `live` extras add the MCP SDK, DuckDB and the Anthropic SDK.
+
+## A contract
+
+```yaml
+contract_version: "0.1"
+domain: subscriptions
+owner: { team: analytics-engineering, contact: analytics-eng@example.com }
+dimensions:
+  - { name: date, type: time, grains: [day, week, month] }
+  - { name: plan, type: categorical, values: [free, starter, pro, enterprise] }
+metrics:
+  - name: active_subscribers
+    kind: measure
+    formula: count(subscription_id)
+    source: { table: fct_subscriber_snapshot_daily, grain: [date, subscription_id], time_dimension: date }
+    additivity: semi_additive
+    non_additive_dimensions:
+      - { field: date, window: last }
+    dimensions: { allowed: [date, plan, region], time_grains: [day, week, month] }
+    refresh: { cadence: daily, lands_at: "06:00Z", settling_window: P1D }
+    as_of: { semantics: snapshot, snapshot_at: end_of_day }
+    caveats:
+      - A month-end figure is the last daily snapshot, never a sum of days.
+```
+
+The full example with an additive measure, a semi-additive snapshot, a non-additive ratio and a
+distinct count is in [examples/saas](examples/saas/subscriptions.contract.yaml). The JSON Schema
+is committed under [schema/](schema/) and regenerated from the pydantic models in CI.
+
+## Before and after
+
+`python demo/before_after.py` seeds a synthetic DuckDB database and asks two scripted agents the
+same question: total active subscribers by month for Q1, split by plan. Measured output of the
+committed seed:
+
+- Agent A has only the table name. It writes `COUNT(subscription_id) ... GROUP BY month` over a
+  daily snapshot table and reports a total 23.3x the month-end truth.
+- Agent B calls `plan_query` first, receives `{"date": "last", "plan": "sum"}` and a reference
+  query, and matches the month-end truth row for row.
+- Agent B then asks to SUM across months and is denied with
+  `P04_sum_over_non_additive_dim: active_subscribers is semi-additive over date`.
+
+`python demo/before_after.py --live` runs the same two prompts through a real model with
+`plan_query` exposed as a tool (needs `ANTHROPIC_API_KEY` and the `live` extra) and prints the SQL
+each one wrote.
+
+## MCP server
+
+```bash
+metric-contracts serve -c examples/saas            # stdio
+metric-contracts serve -c examples/saas --http     # streamable-http on 127.0.0.1:8765
+```
+
+Claude Desktop / Claude Code config:
+
+```json
+{ "mcpServers": { "metric-contracts": { "command": "metric-contracts", "args": ["serve", "-c", "/path/to/contracts"] } } }
+```
+
+Tools: `list_metrics`, `get_contract`, `plan_query`, `check_chart`, `check_decomposition`,
+`list_dimensions`, `validate_contracts`. Resources: `contract://schema`,
+`contract://schema/payload`, `contract://{domain}`. The server's instructions tell the agent to
+plan before it queries and to treat a denial as an answer, not an obstacle.
+
+## CI
+
+```yaml
+- uses: val-ye/metric-contracts@v0
+  with:
+    paths: contracts/
+```
+
+Or `pipx run metric-contracts validate contracts/ --format github`. Exit code 1 on any error;
+findings are emitted as GitHub annotations.
+
+## Rules
+
+Every rule names the contract field it reads, so a veto is explainable and testable.
+
+| Family | Ids | What they check |
+|---|---|---|
+| Validate | V00-V15 | schema, semi-additive names its dimension, allowed dims in registry, grains, ratio components, distinct count non-additive, source or components, owner, refresh, as-of, dangling components, ordinal funnel dims, unique names, no TODO markers |
+| Plan | P01-P06 | unknown metric, dimension not allowed, grain not allowed, sum over the non-additive dimension, ratio aggregated directly, distinct count rolled up |
+| Chart | C01-C14 | ratio stacked / pie'd / summed, semi-additive at coarse grain takes the declared window, semi-additive stacked over time, distinct count summed, pie cap, pie needs additive, funnel needs ordinal stages, duplicate axis values, dimension and grain allowed, settling window unmarked, series density |
+| Decompose | D01-D06 | sums to total within tolerance, one partition, partition allowed, ratio needs a method, semi-additive deltas are last-to-last, residual disclosed and bounded |
+
+Full tables with the field each rule reads: [docs/design.md](docs/design.md).
+
+## Interop
+
+```bash
+metric-contracts import dbt target/semantic_manifest.json --out contracts/   # stubs with TODO markers
+metric-contracts import ossie model.yaml --out contracts/
+metric-contracts export ossie -c contracts/ --out model.ossie.yaml           # payload in custom_extensions
+```
+
+The dbt importer maps `non_additive_dimension.window_choice` `max` to `last` and `min` to
+`first`, `count_distinct` to a non-additive distinct count, ratio metrics to `components`.
+Refresh, as-of, owner and allowed dimensions are never inferred; they come back as `TODO` and
+`validate` fails until a human declares them.
+
+## What this is not
+
+metric-contracts is not a query engine, not a semantic layer, and not a replacement for dbt,
+Cube, MetricFlow, Malloy or LookML. It does not compute metrics. It holds the declarations those
+tools leave implicit, checks them in CI, and hands them to agents, chart builders and insight
+generators so the rules are enforced where the mistakes happen. The reference SQL `plan` emits
+is a DuckDB illustration of the aggregation plan, not a dialect-aware compiler.
+
+## Development
+
+```bash
+uv venv && uv pip install -e ".[dev]"
+pytest
+ruff check src tests demo examples && mypy
+metric-contracts schema --write schema      # regenerate after a model change
+```
+
+Apache-2.0. Everything in `examples/` is synthetic.

metric_contracts-0.1.0/examples/saas/seed_duckdb.py

@@ -0,0 +1,70 @@
+"""Generate the synthetic SaaS tables the example contracts point at.
+
+Deterministic (fixed seed). Writes examples/saas/saas.duckdb unless a path is
+given. Nothing here comes from a real company.
+"""
+
+from __future__ import annotations
+
+import random
+import sys
+from datetime import date, timedelta
+from pathlib import Path
+
+import duckdb
+
+PLANS = ["free", "starter", "pro", "enterprise"]
+REGIONS = ["na", "emea", "apac", "latam", "anz", "mea"]
+CHANNELS = [f"ch_{i:02d}" for i in range(1, 13)]
+START = date(2026, 1, 1)
+END = date(2026, 6, 30)
+
+
+def seed(path: Path, seed_value: int = 7) -> None:
+    rng = random.Random(seed_value)
+    if path.exists():
+        path.unlink()
+    con = duckdb.connect(str(path))
+    con.execute("CREATE TABLE fct_subscription_events (date DATE, subscription_id INTEGER, event_type VARCHAR, plan VARCHAR, region VARCHAR, channel VARCHAR)")
+    con.execute("CREATE TABLE fct_subscriber_snapshot_daily (date DATE, subscription_id INTEGER, plan VARCHAR, region VARCHAR)")
+    con.execute("CREATE TABLE fct_trial_events (date DATE, trial_id INTEGER, plan VARCHAR, channel VARCHAR, converted BOOLEAN)")
+    con.execute("CREATE TABLE fct_account_activity (date DATE, account_id INTEGER, region VARCHAR)")
+
+    active: dict[int, tuple[str, str, str]] = {}
+    next_id = 1
+    events = []
+    snapshots = []
+    trials = []
+    activity = []
+    trial_id = 1
+    day = START
+    while day <= END:
+        starts = rng.randint(25, 45) + (10 if day.weekday() < 5 else 0)
+        for _ in range(starts):
+            sub = (rng.choice(PLANS[1:]), rng.choice(REGIONS), rng.choice(CHANNELS))
+            active[next_id] = sub
+            events.append((day, next_id, "start", *sub))
+            next_id += 1
+        for sid in list(active):
+            if rng.random() < 0.004:
+                events.append((day, sid, "cancel", *active.pop(sid)))
+        for sid, (plan, region, _) in active.items():
+            snapshots.append((day, sid, plan, region))
+        for _ in range(rng.randint(60, 90)):
+            trials.append((day, trial_id, rng.choice(PLANS[1:]), rng.choice(CHANNELS), rng.random() < 0.22))
+            trial_id += 1
+        for aid in rng.sample(range(1, 4000), rng.randint(900, 1300)):
+            activity.append((day, aid, REGIONS[aid % len(REGIONS)]))
+        day += timedelta(days=1)
+
+    con.executemany("INSERT INTO fct_subscription_events VALUES (?,?,?,?,?,?)", events)
+    con.executemany("INSERT INTO fct_subscriber_snapshot_daily VALUES (?,?,?,?)", snapshots)
+    con.executemany("INSERT INTO fct_trial_events VALUES (?,?,?,?,?)", trials)
+    con.executemany("INSERT INTO fct_account_activity VALUES (?,?,?)", activity)
+    con.close()
+
+
+if __name__ == "__main__":
+    out = Path(sys.argv[1]) if len(sys.argv) > 1 else Path(__file__).with_name("saas.duckdb")
+    seed(out)
+    print(f"wrote {out}")