mcp-groundtruth 0.2.0__tar.gz

mcp_groundtruth-0.2.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.pyc
+.venv/
+.pytest_cache/
+dist/
+*.egg-info/
+runs/
+.mcpgt/

mcp_groundtruth-0.2.0/CHANGELOG.md

@@ -0,0 +1,121 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2026-10-14
+
+Audits real servers, and makes it practical to test your own. Adds audit
+targets for third-party servers, `mcpgt init`, a step-by-step guide with an
+example server, and a GitHub Action that fails CI on a VIOLATION. First
+release packaged for PyPI.
+
+### Added
+
+Audit targets:
+
+- Audit targets (`targets/<name>/target.toml`): servers with no expected
+  verdicts, run with `mcpgt run <target> --audit`, which writes the full
+  report and exits 0 whatever the verdicts.
+- Pinned sources: `mcpgt prepare <target>` fetches one git commit and builds
+  it, the only step that uses the network. Every run verifies the checkout
+  offline and records repository, commit, package, artifact digest and
+  toolchain in provenance.
+- Node major-version pin for targets (`node = "24"`), enforced at build and
+  run time; the binary used is recorded in provenance.
+- Sandboxed server processes for targets: no network (macOS `sandbox-exec`,
+  Linux `unshare`), and on macOS no file writes outside the state directory.
+- JSON Lines support in the JSON adapter, with `partition_by` and `explode`.
+  A directory adapter can observe the whole state directory and delegate
+  nested files to other adapters.
+- Argument variants: several `[[tools]]` entries for one tool, each with a
+  `variant` label and its own verdicts. `--tool` is repeatable and accepts
+  `name[variant]`.
+- `--observe-concurrent`: observation-only concurrent attempts for tools
+  without a falsifiable idempotence claim; verdicts are unchanged.
+- Reports carry each adapter's modelling decisions and notes under
+  `definition.adapters`.
+- `targets/memory`: the reference memory server pinned at
+  `modelcontextprotocol/servers@bbb701e`, with its reviewed audit in
+  `results/memory-2026-10-14/`.
+
+Testing your own server:
+
+- `mcpgt init <dir> -- <server command>`: starts a server in the audit
+  sandbox, lists its tools and writes a starting `target.toml`. It contains:
+  - every tool, with its declared hints as comments;
+  - argument placeholders from each tool's input schema;
+  - `TODO(mcpgt)` placeholders for state locations, adapters, classification
+    and masks, which are never guessed.
+
+  A definition with any `TODO(mcpgt)` value left refuses to load and lists
+  each one.
+- `{target}` placeholder (the definition's directory) in commands and `env`.
+  `{state}` is now also expanded in commands.
+- [docs/your-server.md](docs/your-server.md): testing your own server from
+  install to report.
+- `examples/notes`: a small SQLite-backed server for the guide, with one
+  deliberate annotation bug. Tests keep the guide's claims true.
+
+CI:
+
+- `--fail-on-violation`: `mcpgt run` exits 1 if any verdict is VIOLATION;
+  `--audit` alone still exits 0.
+- A composite GitHub Action (`action.yml`) that audits a target, fails the
+  job on any VIOLATION, and uploads the report as an artifact. CI runs it
+  against `examples/notes` on Ubuntu and macOS. The guide warns that the
+  user-namespace sysctl the Linux sandbox needs on Ubuntu 24.04 is for
+  ephemeral GitHub-hosted runners only.
+
+Packaging:
+
+- Packaged for PyPI as `mcp-groundtruth`, installing the `mcpgt` command
+  (also as `mcp-groundtruth`). A release workflow publishes version tags
+  through PyPI trusted publishing after the full CI suite passes.
+
+### Changed
+
+- The distribution is named `mcp-groundtruth` (was `mcpgt`, never
+  published); the import package and command stay `mcpgt`.
+- Report schema `mcpgt.report/0.2`: adds `mode`, `kind`, and provenance
+  `definition` and `runtime`.
+- Provenance records the Node binary's path relative to the working
+  directory (for example `.mcpgt/toolchains/...`), or as `~/...` under the
+  home directory, so published reports do not reveal the local directory
+  layout.
+- README links are absolute, so they resolve on PyPI.
+
+## [0.1.0] - 2026-10-13
+
+First release. Validates the harness against fixture servers with known
+ground truth; does not test third-party servers.
+
+### Added
+
+- Tri-state declared contracts (`TRUE` / `FALSE` / `ABSENT`) parsed from raw
+  `tools/list` responses, with recorded parse anomalies for non-boolean,
+  null, duplicated and misplaced hints.
+- JSON-RPC stdio client that keeps every response verbatim, follows
+  `nextCursor`, routes concurrent requests and measures call timing.
+- Snapshot adapters for SQLite databases, directory trees and JSON document
+  files, with coverage reporting and business / append-only / unclassified
+  state classification.
+- Declared-only normalization of volatile fields, validated against the
+  seeded state.
+- Reset verification, control sessions, and the test battery: sequential
+  idempotence, concurrent idempotence (single-connection and two-process
+  modes, one-sided), read-only and destructive.
+- Verdict engine with `PASS`, `VIOLATION`, `INCONCLUSIVE` and
+  `NOT_APPLICABLE`, primary and secondary reasons, and declaration
+  coherence checks.
+- Self-contained JSON reports with provenance, raw protocol data and
+  per-verdict evidence; `mcpgt verify-reset`, `run` and `report` commands.
+- Eleven ground-truth fixture servers and an end-to-end ground-truth test.
+- Methodology documentation.
+
+[Unreleased]: https://github.com/shreyasbhakta/mcp-groundtruth/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/shreyasbhakta/mcp-groundtruth/releases/tag/v0.2.0
+[0.1.0]: https://github.com/shreyasbhakta/mcp-groundtruth/releases/tag/v0.1.0

mcp_groundtruth-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributor notes
+
+## Development environment
+
+- Use `uv` for everything Python: `uv sync`, `uv run pytest`,
+  `uv run ruff check .`, `uv run ruff format --check .`, `uv run mypy`.
+  CI runs the same commands on Python 3.11 and 3.14.
+- **Never install, upgrade or remove system packages** (Homebrew, apt,
+  global `npm -g` or global `pip`) as part of working on this project without
+  the maintainer's explicit approval first. Package managers can upgrade or
+  clean up unrelated software as a side effect.
+- **Keep toolchains project-local**, inside `.mcpgt/` (git-ignored). Example:
+  Node 24 for audit targets lives in
+  `.mcpgt/toolchains/node-v<version>-<platform>/`, downloaded from
+  nodejs.org and checked against the published `SHASUMS256.txt` before use.
+  Put it first on `PATH` for `mcpgt prepare` and `mcpgt run`.
+- Third-party target sources are fetched and built only by
+  `mcpgt prepare`, into `.mcpgt/sources/`. Never edit files there: runs refuse
+  a checkout with modified tracked files.
+
+## Changes to the harness
+
+- Every behavior change needs a test. For verdict logic, also check that a
+  deliberately introduced bug is caught by the test suite.
+- Modelling decisions (masks, classification, explode, partitioning) are
+  declared in fixture or target definitions, never inferred, and each comes
+  with a `notes` explanation where it is not obvious.
+- Fixtures must record an expected verdict for every tool and implemented
+  test; `tests/test_ground_truth.py` enforces this.
+
+## Audit results
+
+- Audit reports in `runs/` are git-ignored. Nothing about a third-party
+  server's results is committed, published or mentioned in documentation
+  until it has been reviewed by hand against the raw evidence.
+- If a reviewed result shows a VIOLATION on someone else's server, disclose it
+  to that server's maintainers before anything is made public.
+- Report over-declarations (behavior safer than declared) as
+  over-declarations, never as violations.

mcp_groundtruth-0.2.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.

mcp_groundtruth-0.2.0/NOTICE

@@ -0,0 +1,10 @@
+mcp-groundtruth
+Copyright 2026 The mcp-groundtruth contributors
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+It contains no third-party source code. At run time it depends on the
+following separately licensed package, which is not redistributed here:
+
+  mcp (Model Context Protocol Python SDK), MIT License
+  https://github.com/modelcontextprotocol/python-sdk