needlepath 0.1.0__tar.gz

needlepath-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+dist/
+build/
+*.egg-info/
+__pycache__/
+node_modules/
+*.tsbuildinfo

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

needlepath-0.1.0/PKG-INFO

@@ -0,0 +1,251 @@
+Metadata-Version: 2.4
+Name: needlepath
+Version: 0.1.0
+Summary: Framework-free client for the Needlepath hosted context-selection service.
+Project-URL: Homepage, https://nextmoca.com
+Author: Next Moca Global, Inc.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,context,context-engineering,llm,needlepath
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: httpx
+Requires-Dist: httpx>=0.24; extra == 'httpx'
+Description-Content-Type: text/markdown
+
+# `needlepath` — Python client
+
+The framework-free core client for the Needlepath hosted context-selection
+service. HTTP only, zero required dependencies, one transport/auth seam.
+
+Framework integrations are **separate distributions** and depend on this one:
+
+| Distribution | Seam |
+|---|---|
+| [`needlepath-langchain`](../needlepath-langchain) | `AgentMiddleware` (`wrap_model_call`, `wrap_tool_call`) + the LangGraph recipe |
+| [`needlepath-litellm`](../needlepath-litellm) | LiteLLM **proxy** `CustomGuardrail` |
+| [`llama-index-postprocessor-needlepath`](../llama-index-postprocessor-needlepath) | `BaseNodePostprocessor` |
+
+## Install
+
+```bash
+pip install needlepath
+pip install "needlepath[httpx]"   # optional: httpx-backed async transport
+```
+
+Python 3.9+. No required runtime dependencies — the default transport is stdlib
+`urllib`, so installing this client can never move a version you already pinned.
+
+## Quickstart
+
+```python
+from needlepath import NeedlepathClient, ContextRecord, TaskSpec
+
+client = NeedlepathClient(
+    api_key="np_live_...",  # or NEEDLEPATH_API_KEY
+    operating_point="np-2026-07-r2",  # required — see "Pin the operating point"
+)
+
+result = client.select(
+    records=[
+        ContextRecord(text=tool_output, kind="tool_result", id="lookup-1"),
+        ContextRecord(text=doc, kind="external_data", id="doc-7", title="SOP"),
+    ],
+    task=TaskSpec(prompt="what is the invoice total for A-1002?"),
+    max_context_tokens=4000,
+)
+
+context = result.rendered_context if result.applied else my_original_context
+```
+
+`select()` **never raises.** Read `result.applied`; when it is `False`, use your
+original context. That is the whole integration contract.
+
+### Async
+
+```python
+from needlepath import AsyncNeedlepathClient
+
+async with AsyncNeedlepathClient(operating_point="np-2026-07-r2") as client:
+    result = await client.select(records=..., task=..., max_context_tokens=4000)
+```
+
+Identical semantics — the decision logic is literally the same functions. Uses
+`httpx.AsyncClient` when httpx is importable, a worker thread otherwise; it
+never blocks the event loop either way.
+
+## Configuration
+
+| Argument | Environment | Default |
+|---|---|---|
+| `api_key` | `NEEDLEPATH_API_KEY` | none (no `Authorization` header) |
+| `operating_point` | `NEEDLEPATH_OPERATING_POINT` | **required** |
+| `base_url` | `NEEDLEPATH_BASE_URL` | `https://ayf02egtaf.execute-api.us-east-2.amazonaws.com/prod` |
+| `timeout` | — | `10.0` s, total, retries included |
+| `max_retries` | — | `2` |
+| `max_request_bytes` | — | `6 * 1024 * 1024` |
+| `shadow` | — | `False` |
+
+The base URL is a **documented default, not a hard-coded one**: a durable custom
+domain replaces it, and swapping it is a config change rather than a release.
+
+`http://` is refused for any non-loopback host. TLS-only is an inherited binding
+constraint; loopback is exempt so the localhost benchmark adapter still works.
+
+## The four binding rules, and where they live
+
+### 1. Fail open, always
+
+Timeout, 5xx, a violated contract, an empty selection, a stood-down gate — every
+one of them returns a `SelectionResult` with `applied=False`, the exception on
+`.error`, and a machine-readable `.reason`. Nothing is raised on the selection
+path.
+
+```python
+if not result.applied:
+    log.info("needlepath passthrough", extra=result.metadata())
+    context = my_original_context
+```
+
+`result.reason` is an **open enum** (`needlepath.Reason`). Today:
+
+| reason | applied | meaning |
+|---|---|---|
+| `ok` | yes | safe to apply |
+| `shadow` | no | shadow mode — measured, deliberately not applied |
+| `disabled` | no | the integration was constructed disabled |
+| `no_records` | no | nothing to select over; no call was made |
+| `below_trigger` | no | under the configured trigger; no call was made |
+| `empty_selection` | no | zero records selected |
+| `engine_fallback` | no | `fallback_used` — the engine wants the full context |
+| `selection_error` | no | the response carried a `selection_error` |
+| `no_per_record_detail` | no | per-record detail was required and absent |
+| `payload_too_large` | no | over the client-side guard; **no call was made** |
+| `timeout` / `transport_error` / `http_error` / `contract_error` | no | error paths |
+| `unexpected_error` | no | a defect in this client — still fails open |
+
+Treat an unrecognized reason as "do not apply". `result.failed` separates the
+error paths from the benign declines, which is the distinction that decides
+whether a passthrough deserves a `WARNING` or a `DEBUG`.
+
+The empty-selection rule is not a nicety. NEXPE-413 is the precedent: the engine
+returned an empty selection as a success, and at a framework boundary that has
+to degrade to passthrough, never to an empty context.
+
+**`select_or_raise()` exists** for the two cases where fail-open is wrong —
+diagnostics, and a caller that is itself a benchmark and must not silently
+substitute a passthrough for a measurement. Do not use it in an adapter.
+
+### 2. Pin the operating point
+
+`operating_point` is required at construction, and this is the one failure that
+raises rather than fails open. Failing open on a bad request is degradation a
+customer absorbs; failing open on "no operating point was pinned" accepts
+exactly the behaviour drift the rule exists to prevent. It fails at wire-up,
+never under load.
+
+Labels are immutable: `np-2026-07-r2` means one frozen configuration forever, and
+a retune mints a new label. `client.operating_points()` lists what the endpoint
+serves — call it once at wire-up if you want the assertion, never per request.
+
+### 3. Guard the 6 MB cap client-side
+
+The serialized body is measured before it is sent. Over the guard, you get
+`reason="payload_too_large"` and **no network call**, rather than a platform
+error from the far side of the wire.
+
+The guard measures the JSON body. Lambda's 6 MB limit applies to the whole
+invocation payload — the API Gateway event envelope sits on top — so a request
+that passes at 5.99 MB can still be rejected upstream. Lower
+`max_request_bytes` if you run near the cap.
+
+### 4. Shadow mode is a one-line switch
+
+```python
+client = NeedlepathClient(operating_point="np-2026-07-r2", shadow=True)
+```
+
+The call is made exactly as a live call would be — same body, same billing, same
+operating point — the full response comes back and is reported, and **the
+selection is never applied**. Measure what Needlepath would have saved you;
+change nothing.
+
+`budget.mode = "shadow"` is **not on the wire yet**. `BudgetSpec.mode` on the
+published contract accepts `fixed` and `adaptive` only; adding `shadow` is a
+public-repo contract change (§0.1, sequenced in E7). The wire half is behind
+`needlepath.features.WIRE_SHADOW_MODE`; flip it in the same change that lands the
+field. Client-side behaviour does not change when you do — it is already correct.
+
+## Retries
+
+Retried: `429`, `502`, `503`, `504`, and transport failures. `Retry-After` is
+honoured in delta-seconds form. Backoff is full-jitter exponential, and every
+retry is bounded by the `timeout` deadline — retries can never exceed the budget
+the caller gave you.
+
+**`500` is not retried.** A 500 from this endpoint is `engine_error`: a
+deterministic failure on this exact input. Retrying buys nothing, doubles the
+latency before you fail open, and spends a second billable invocation on a
+request that will fail identically.
+
+POST is safe to retry here because the endpoint is stateless and idempotent by
+contract (`ADAPTER_API_DESIGN.md` invariant 1).
+
+## Metadata
+
+`result.metadata()` is a flat, **metadata-only** dict built for a framework's
+metadata blob:
+
+```python
+{"needlepath.applied": False, "needlepath.reason": "engine_fallback",
+ "needlepath.tokens_before": 8400, "needlepath.tokens_saved": 0,
+ "needlepath.gate_reason": "standdown:flat_gap", ...}
+```
+
+Nothing derived from record text is in it. One consequence is non-obvious:
+`selection_error` is built server-side as `f"{type(exc).__name__}: {exc}"` and can
+carry fragments of your input in an exception message — the Lambda deliberately
+declines to log it for that reason — so only its *type* appears here. The full
+string stays on `result.response.selection_error`.
+
+## Testing your integration
+
+```python
+from needlepath.testing import FakeTransport, response_payload, ok, error
+
+transport = FakeTransport([error(503), ok(response_payload("np-1"))])
+client = NeedlepathClient(operating_point="np-2026-07-r2", transport=transport)
+```
+
+`needlepath.testing` is public API, not a private helper. Every rule above is a
+rule about what happens when the service misbehaves, and you cannot test that
+against a healthy service.
+
+## Wire contract
+
+`INTERFACE.md` in `context-selection-bench` is the published contract; the
+dataclasses here are an independent implementation of it, deliberately copied
+rather than imported so a research harness never lands in a customer's
+dependency tree. `tests/test_wire_compatibility.py` asserts they have not
+drifted.
+
+Unknown response fields are kept on `response.extra`, never rejected: `/v1` is
+additive, and `usage` (E2) is already scheduled to arrive that way.
+
+The gate outcome and `reason` are an **open enum**. Nothing in this SDK branches
+on them and nothing you build on it should — a third outcome is a planned
+additive change.

needlepath-0.1.0/README.md

@@ -0,0 +1,222 @@
+# `needlepath` — Python client
+
+The framework-free core client for the Needlepath hosted context-selection
+service. HTTP only, zero required dependencies, one transport/auth seam.
+
+Framework integrations are **separate distributions** and depend on this one:
+
+| Distribution | Seam |
+|---|---|
+| [`needlepath-langchain`](../needlepath-langchain) | `AgentMiddleware` (`wrap_model_call`, `wrap_tool_call`) + the LangGraph recipe |
+| [`needlepath-litellm`](../needlepath-litellm) | LiteLLM **proxy** `CustomGuardrail` |
+| [`llama-index-postprocessor-needlepath`](../llama-index-postprocessor-needlepath) | `BaseNodePostprocessor` |
+
+## Install
+
+```bash
+pip install needlepath
+pip install "needlepath[httpx]"   # optional: httpx-backed async transport
+```
+
+Python 3.9+. No required runtime dependencies — the default transport is stdlib
+`urllib`, so installing this client can never move a version you already pinned.
+
+## Quickstart
+
+```python
+from needlepath import NeedlepathClient, ContextRecord, TaskSpec
+
+client = NeedlepathClient(
+    api_key="np_live_...",  # or NEEDLEPATH_API_KEY
+    operating_point="np-2026-07-r2",  # required — see "Pin the operating point"
+)
+
+result = client.select(
+    records=[
+        ContextRecord(text=tool_output, kind="tool_result", id="lookup-1"),
+        ContextRecord(text=doc, kind="external_data", id="doc-7", title="SOP"),
+    ],
+    task=TaskSpec(prompt="what is the invoice total for A-1002?"),
+    max_context_tokens=4000,
+)
+
+context = result.rendered_context if result.applied else my_original_context
+```
+
+`select()` **never raises.** Read `result.applied`; when it is `False`, use your
+original context. That is the whole integration contract.
+
+### Async
+
+```python
+from needlepath import AsyncNeedlepathClient
+
+async with AsyncNeedlepathClient(operating_point="np-2026-07-r2") as client:
+    result = await client.select(records=..., task=..., max_context_tokens=4000)
+```
+
+Identical semantics — the decision logic is literally the same functions. Uses
+`httpx.AsyncClient` when httpx is importable, a worker thread otherwise; it
+never blocks the event loop either way.
+
+## Configuration
+
+| Argument | Environment | Default |
+|---|---|---|
+| `api_key` | `NEEDLEPATH_API_KEY` | none (no `Authorization` header) |
+| `operating_point` | `NEEDLEPATH_OPERATING_POINT` | **required** |
+| `base_url` | `NEEDLEPATH_BASE_URL` | `https://ayf02egtaf.execute-api.us-east-2.amazonaws.com/prod` |
+| `timeout` | — | `10.0` s, total, retries included |
+| `max_retries` | — | `2` |
+| `max_request_bytes` | — | `6 * 1024 * 1024` |
+| `shadow` | — | `False` |
+
+The base URL is a **documented default, not a hard-coded one**: a durable custom
+domain replaces it, and swapping it is a config change rather than a release.
+
+`http://` is refused for any non-loopback host. TLS-only is an inherited binding
+constraint; loopback is exempt so the localhost benchmark adapter still works.
+
+## The four binding rules, and where they live
+
+### 1. Fail open, always
+
+Timeout, 5xx, a violated contract, an empty selection, a stood-down gate — every
+one of them returns a `SelectionResult` with `applied=False`, the exception on
+`.error`, and a machine-readable `.reason`. Nothing is raised on the selection
+path.
+
+```python
+if not result.applied:
+    log.info("needlepath passthrough", extra=result.metadata())
+    context = my_original_context
+```
+
+`result.reason` is an **open enum** (`needlepath.Reason`). Today:
+
+| reason | applied | meaning |
+|---|---|---|
+| `ok` | yes | safe to apply |
+| `shadow` | no | shadow mode — measured, deliberately not applied |
+| `disabled` | no | the integration was constructed disabled |
+| `no_records` | no | nothing to select over; no call was made |
+| `below_trigger` | no | under the configured trigger; no call was made |
+| `empty_selection` | no | zero records selected |
+| `engine_fallback` | no | `fallback_used` — the engine wants the full context |
+| `selection_error` | no | the response carried a `selection_error` |
+| `no_per_record_detail` | no | per-record detail was required and absent |
+| `payload_too_large` | no | over the client-side guard; **no call was made** |
+| `timeout` / `transport_error` / `http_error` / `contract_error` | no | error paths |
+| `unexpected_error` | no | a defect in this client — still fails open |
+
+Treat an unrecognized reason as "do not apply". `result.failed` separates the
+error paths from the benign declines, which is the distinction that decides
+whether a passthrough deserves a `WARNING` or a `DEBUG`.
+
+The empty-selection rule is not a nicety. NEXPE-413 is the precedent: the engine
+returned an empty selection as a success, and at a framework boundary that has
+to degrade to passthrough, never to an empty context.
+
+**`select_or_raise()` exists** for the two cases where fail-open is wrong —
+diagnostics, and a caller that is itself a benchmark and must not silently
+substitute a passthrough for a measurement. Do not use it in an adapter.
+
+### 2. Pin the operating point
+
+`operating_point` is required at construction, and this is the one failure that
+raises rather than fails open. Failing open on a bad request is degradation a
+customer absorbs; failing open on "no operating point was pinned" accepts
+exactly the behaviour drift the rule exists to prevent. It fails at wire-up,
+never under load.
+
+Labels are immutable: `np-2026-07-r2` means one frozen configuration forever, and
+a retune mints a new label. `client.operating_points()` lists what the endpoint
+serves — call it once at wire-up if you want the assertion, never per request.
+
+### 3. Guard the 6 MB cap client-side
+
+The serialized body is measured before it is sent. Over the guard, you get
+`reason="payload_too_large"` and **no network call**, rather than a platform
+error from the far side of the wire.
+
+The guard measures the JSON body. Lambda's 6 MB limit applies to the whole
+invocation payload — the API Gateway event envelope sits on top — so a request
+that passes at 5.99 MB can still be rejected upstream. Lower
+`max_request_bytes` if you run near the cap.
+
+### 4. Shadow mode is a one-line switch
+
+```python
+client = NeedlepathClient(operating_point="np-2026-07-r2", shadow=True)
+```
+
+The call is made exactly as a live call would be — same body, same billing, same
+operating point — the full response comes back and is reported, and **the
+selection is never applied**. Measure what Needlepath would have saved you;
+change nothing.
+
+`budget.mode = "shadow"` is **not on the wire yet**. `BudgetSpec.mode` on the
+published contract accepts `fixed` and `adaptive` only; adding `shadow` is a
+public-repo contract change (§0.1, sequenced in E7). The wire half is behind
+`needlepath.features.WIRE_SHADOW_MODE`; flip it in the same change that lands the
+field. Client-side behaviour does not change when you do — it is already correct.
+
+## Retries
+
+Retried: `429`, `502`, `503`, `504`, and transport failures. `Retry-After` is
+honoured in delta-seconds form. Backoff is full-jitter exponential, and every
+retry is bounded by the `timeout` deadline — retries can never exceed the budget
+the caller gave you.
+
+**`500` is not retried.** A 500 from this endpoint is `engine_error`: a
+deterministic failure on this exact input. Retrying buys nothing, doubles the
+latency before you fail open, and spends a second billable invocation on a
+request that will fail identically.
+
+POST is safe to retry here because the endpoint is stateless and idempotent by
+contract (`ADAPTER_API_DESIGN.md` invariant 1).
+
+## Metadata
+
+`result.metadata()` is a flat, **metadata-only** dict built for a framework's
+metadata blob:
+
+```python
+{"needlepath.applied": False, "needlepath.reason": "engine_fallback",
+ "needlepath.tokens_before": 8400, "needlepath.tokens_saved": 0,
+ "needlepath.gate_reason": "standdown:flat_gap", ...}
+```
+
+Nothing derived from record text is in it. One consequence is non-obvious:
+`selection_error` is built server-side as `f"{type(exc).__name__}: {exc}"` and can
+carry fragments of your input in an exception message — the Lambda deliberately
+declines to log it for that reason — so only its *type* appears here. The full
+string stays on `result.response.selection_error`.
+
+## Testing your integration
+
+```python
+from needlepath.testing import FakeTransport, response_payload, ok, error
+
+transport = FakeTransport([error(503), ok(response_payload("np-1"))])
+client = NeedlepathClient(operating_point="np-2026-07-r2", transport=transport)
+```
+
+`needlepath.testing` is public API, not a private helper. Every rule above is a
+rule about what happens when the service misbehaves, and you cannot test that
+against a healthy service.
+
+## Wire contract
+
+`INTERFACE.md` in `context-selection-bench` is the published contract; the
+dataclasses here are an independent implementation of it, deliberately copied
+rather than imported so a research harness never lands in a customer's
+dependency tree. `tests/test_wire_compatibility.py` asserts they have not
+drifted.
+
+Unknown response fields are kept on `response.extra`, never rejected: `/v1` is
+additive, and `usage` (E2) is already scheduled to arrive that way.
+
+The gate outcome and `reason` are an **open enum**. Nothing in this SDK branches
+on them and nothing you build on it should — a third outcome is a planned
+additive change.