Skip to content

Commit 294d519

Browse files
authored
Align current-boundary docs with v0.2.2 (#25)
1 parent 0988b09 commit 294d519

8 files changed

Lines changed: 25 additions & 7 deletions

docs/dev_experience_content_plan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation Refresh Content Plan (Phase 2)
22

3-
> Historical planning artifact. The `v0.2.0` release has since repositioned the public server around evidence federation and interop; use this document as background context, not as the current public contract.
3+
> Historical planning artifact. The `v0.2.2` release preserves the public server boundary around evidence federation and interop; use this document as background context, not as the current public contract.
44
55
## Goals
66
- Update public and internal documentation to reflect MCP Phase 2 architecture, guardrails, observability, and developer tooling.

docs/development_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document provides guidance for developers who want to extend or modify the EPA CompTox MCP implementation.
44

5-
The released `v0.2.0` public server is an evidence-and-federation MCP. Predictive and orchestrator code still exists in-repo, but it is not part of the default public MCP surface unless explicitly registered and documented.
5+
The released `v0.2.2` public server is an evidence-and-federation MCP. Predictive and orchestrator code still exists in-repo, but it is not part of the default public MCP surface unless explicitly registered and documented.
66

77
## Project Structure
88

docs/model_cards_and_policies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Model Cards & Guardrail Policies
22

3-
> This guide primarily covers in-repo predictive and orchestrator assets. These components remain experimental and are not part of the default public MCP tool catalog in `v0.2.0`.
3+
> This guide primarily covers in-repo predictive and orchestrator assets. These components remain experimental and are not part of the default public MCP tool catalog in `v0.2.2`.
44
55
This guide explains how to publish human-readable summaries for machine-readable model cards and applicability-domain (AD) policies, interpret guardrail outcomes, and follow the governance workflow required for release sign-off.
66

docs/observability_requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Observability & Governance Requirements (MCP Phase 2)
22

3-
> Historical/internal planning document. These requirements cover broader transport, predictive, and orchestrator ambitions beyond the current default public MCP surface released in `v0.2.0`.
3+
> Historical/internal planning document. These requirements cover broader transport, predictive, and orchestrator ambitions beyond the current default public MCP surface released in `v0.2.2`.
44
55
## Overview
66
To support MCP Phase 2, the platform must expose consistent telemetry, audit, and policy hooks across transport, metadata, predictive services, and the GenRA orchestrator. This document captures the requirements aligned with stakeholder needs.

docs/predictive_services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Predictive Micro-Server Harness
22

3-
> Experimental/internal guide. The predictive service harness described here is not part of the default public MCP tool catalog released in `v0.2.0`.
3+
> Experimental/internal guide. The predictive service harness described here is not part of the default public MCP tool catalog released in `v0.2.2`.
44
55
Phase 2 introduces a shared harness for the TEST, OPERA, and GenRA predictive services. The goal is to give all model micro-servers a consistent structure for request validation, applicability-domain enforcement, and response formatting.
66

docs/releases/mcp_phase2_planning_snapshot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MCP Phase 2 Planning Snapshot (2025-10-25)
22

3-
> Historical planning snapshot retained for archive purposes. It does not describe the current public `v0.2.0` release boundary.
3+
> Historical planning snapshot retained for archive purposes. It does not describe the current public `v0.2.2` release boundary.
44
55
This snapshot captures the planning workspace state after completing the MCP Phase 2 rollout and associated CTX migration tasks.
66

docs/workflow_testing_strategy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Workflow Testing Strategy – MCP Phase 2
22

3-
> Historical/internal workflow-planning document. The released `v0.2.0` public MCP server is centered on evidence federation and interop; predictive and orchestrator workflow coverage described here remains experimental and non-canonical for the default public surface.
3+
> Historical/internal workflow-planning document. The released `v0.2.2` public MCP server is centered on evidence federation and interop; predictive and orchestrator workflow coverage described here remains experimental and non-canonical for the default public surface.
44
55
## Objectives
66
- Guarantee transport, predictive, and orchestrator services behave reliably across success, guardrail, and failure scenarios.

tests/test_release_metadata.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@
2626
)
2727
DEVELOPMENT_GUIDE_PATH = ROOT_DIR / "docs" / "development_guide.md"
2828
INTEROP_SMOKE_SCRIPT_PATH = ROOT_DIR / "scripts" / "mcp_interop_smoke.py"
29+
CURRENT_BOUNDARY_DOC_PATHS = (
30+
ROOT_DIR / "docs" / "development_guide.md",
31+
ROOT_DIR / "docs" / "predictive_services.md",
32+
ROOT_DIR / "docs" / "model_cards_and_policies.md",
33+
ROOT_DIR / "docs" / "workflow_testing_strategy.md",
34+
ROOT_DIR / "docs" / "dev_experience_content_plan.md",
35+
ROOT_DIR / "docs" / "observability_requirements.md",
36+
ROOT_DIR / "docs" / "releases" / "mcp_phase2_planning_snapshot.md",
37+
)
2938

3039

3140
def _read_text(path: Path) -> str:
@@ -152,3 +161,12 @@ def test_live_interop_fixture_refresh_path_is_documented() -> None:
152161
assert "tests/golden/interop_live" in docs
153162
assert "--capture-dir" in docs
154163
assert "--refresh-live-fixtures" in docs
164+
165+
166+
def test_current_boundary_docs_reference_current_release_version() -> None:
167+
version = _project_version()
168+
for path in CURRENT_BOUNDARY_DOC_PATHS:
169+
text = _read_text(path)
170+
assert (
171+
f"v{version}" in text
172+
), f"{path} should reference the current release version"

0 commit comments

Comments
 (0)