@skyold/protocol-engine 0.1.0-beta.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 TokenForge Contributors
+
+   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.

package/README.md

@@ -0,0 +1,466 @@
+# TokenForge Protocol Engine
+
+[简体中文](./README.zh-CN.md) | English
+
+> **New to the Engine?** Start with the practical
+> [Protocol Engine usage guide](../../docs/guides/PROTOCOL_ENGINE.md) (Simplified
+> Chinese). It includes the supported/unsupported matrix, annotated sync,
+> stream, and async examples, architecture diagrams, and the request sequence.
+> This manual remains the complete API and evidence-boundary reference.
+
+`@skyold/protocol-engine` is a Host-neutral execution kernel for AI model
+aggregation. Any application, service, or library that implements the V1 port
+contract can embed it. The Engine neither recognizes nor enumerates external
+application types, and does not import a caller's HTTP framework, database,
+identity model, credentials, pricing, usage store, or settlement policy.
+
+In this manual, **Host** means only the abstract role that embeds and calls the
+Engine. It does not identify a particular product or deployment shape.
+
+## Module status
+
+The Engine is an independent workspace package with one package-root ESM API,
+its own TypeScript build, its own test command, and one runtime dependency:
+`@skyold/model-protocol`. It does not depend on any embedding Host,
+concrete Provider Adapters, storage, HTTP frameworks, credential stores, or
+network clients.
+
+The package and its normalized-contract dependency are configured for public
+npm access, but no registry release has been made yet. Therefore:
+
+- it is independently embeddable and testable by packages in this repository;
+- its packed runtime surface is independently inspectable;
+- packed tarballs can be installed and exercised by an isolated external
+  consumer;
+- public registry availability, a versioned release, and provenance signing are
+  not claimed until the release gate completes.
+
+The local V1 core implementation is complete against its frozen execution
+boundary. Overall rollout certification is still incomplete: fixture-backed
+conformance is green for all nine built-in protocol families, while current
+real-Provider success evidence covers seven. `openai-embeddings/v1` and
+`openai-images/v1` still require successful real-Provider certification.
+Public release, exact-SHA CI, and deployment are separate delivery gates, not
+reasons to add Host business logic to the Engine.
+
+Run its complete package-local gate from the repository root or package
+directory:
+
+```bash
+pnpm --dir packages/protocol-engine check
+```
+
+## Embed V1
+
+```ts
+import {
+  createProtocolEngineTargetBindingV1,
+  createProtocolEngineV1,
+  isProtocolEngineErrorV1,
+  type ProtocolEngineAdapterRegistryPortV1,
+} from '@skyold/protocol-engine';
+
+const registry: ProtocolEngineAdapterRegistryPortV1 = createMyRegistry();
+const binding = createProtocolEngineTargetBindingV1({
+  target: resolvedTarget,
+  bindTransport: (signal) => bindCredentialTransport(resolvedTarget, signal),
+});
+const engine = createProtocolEngineV1({ registry });
+const execution = await engine.execute({ binding, task, signal });
+```
+
+Hosts construct the request-bound execution binding with
+`createProtocolEngineTargetBindingV1({ target, bindTransport })`. The factory
+checks the Engine-requested `connectionRef` against the resolved target before
+delegating credential-bound Transport creation, preventing a target from being
+executed with another connection.
+
+Every V1 Registry exposes `listProtocolFamilies()`. The Engine snapshots that
+inventory as the sorted, immutable `engine.protocolFamilies` view, so embedded
+Hosts, conformance tooling, and certification use the same extension contract.
+The snapshot is also the dispatch authority: execute and async-job operations
+reject undeclared families, and a returned Factory must declare exactly the
+requested family before Transport binding.
+
+The Host resolves identity, policy, target, and credentials before constructing
+the binding; authenticated Host context never enters the Engine API. Host
+governance runs before the Engine call, while usage, audit, and settlement
+consume its returned normalized facts afterwards.
+
+“Unified” means that every embedding consumer uses this same execution lifecycle
+and public contract. It does not merge external application orchestration or move
+identity, routing, credential, governance, usage, or settlement responsibilities
+into the Engine. Consumers may resolve targets differently; after resolution,
+each supplies the same narrow task, target binding, Registry, and Transport ports.
+
+The target's `provider` value is opaque compatibility identity data, not Engine
+dispatch authority. Engine core may carry it into protocol capability
+validation, but must never select behavior by Provider name. This distinction
+matters for semantic facts such as embedding compatibility spaces, where two
+otherwise similar models can produce incompatible vectors. Adding another
+Provider for an existing protocol therefore requires no Engine change; adding
+another model usually changes only Host catalog/capability facts; adding a new
+protocol adds its Codec, Adapter, Registry declaration, and conformance cases
+without adding a Provider or Host branch to Engine core.
+
+The binding exposes only the dispatch fields the Engine uses: Provider, model,
+connection reference, and protocol/model capability. Host-only `sourceId` and
+`capabilityId` remain beside the call in the Host. Engine execution and job
+results do not echo the target back.
+
+## Public API reference
+
+Import every API from the package root. Source and `dist` subpaths are private.
+
+### Runtime exports
+
+| Export                                       | Purpose                                                                 |
+| -------------------------------------------- | ----------------------------------------------------------------------- |
+| `PROTOCOL_ENGINE_API_VERSION`                | Exact V1 identifier: `tokenforge-protocol-engine/v1`.                   |
+| `PROTOCOL_ENGINE_ERROR_CODES_V1`             | Frozen inventory of stable V1 Engine failure codes.                     |
+| `ProtocolEngineErrorV1`                      | Versioned error class for Engine operation failures.                    |
+| `isProtocolEngineErrorV1(error)`             | Cross-realm-safe guard for the public V1 error shape.                   |
+| `createProtocolEngineV1({ registry })`       | Creates an immutable Engine view over one Adapter Registry inventory.   |
+| `createProtocolEngineTargetBindingV1(input)` | Binds one resolved target to one request-scoped Host Transport factory. |
+
+### Exported types
+
+| Type group     | Exports                                                                                                                                                                                                                  |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Engine         | `ProtocolEngineV1`, `ProtocolEngineApiVersion`, `ProtocolEngineAdapterRegistryPortV1`                                                                                                                                    |
+| Execute input  | `ProtocolEngineExecuteInputV1`, `ProtocolEngineDispatchTargetV1`, `ProtocolEngineTargetBindingV1`, `CreateProtocolEngineTargetBindingInputV1`                                                                            |
+| Execute output | `ProtocolEngineExecutionV1`, `ProtocolEngineResponseV1`, `ProtocolEngineStreamV1`, `ProtocolEngineAcceptedJobV1`, `ProtocolEngineRejectedV1`                                                                             |
+| Async jobs     | `ProtocolEngineAsyncJobsV1`, `ProtocolEngineAsyncJobInputV1`, `ProtocolEngineAsyncJobListRequestV1`, `ProtocolEngineAsyncJobObservationV1`, `ProtocolEngineAsyncJobListResultV1`, `ProtocolEngineAsyncJobCancellationV1` |
+| Errors         | `ProtocolEngineErrorV1`, `ProtocolEngineErrorCodeV1`, `ProtocolEngineErrorPhaseV1`, `ProtocolEngineErrorOptionsV1`                                                                                                       |
+
+Normalized task, capability, Adapter, Transport, result, stream-event, usage,
+and job-snapshot types come from `@skyold/model-protocol`; the Engine does
+not duplicate those contracts.
+
+### `createProtocolEngineV1`
+
+```ts
+const engine = createProtocolEngineV1({ registry });
+```
+
+The injected Registry implements:
+
+```ts
+interface ProtocolEngineAdapterRegistryPortV1 {
+  listProtocolFamilies(): readonly ProtocolFamily[];
+  require(protocolFamily: ProtocolFamily): ProviderAdapterFactory;
+  requireAsync?(protocolFamily: ProtocolFamily): ProviderAsyncJobAdapterFactory;
+}
+```
+
+Construction snapshots, sorts, validates, and freezes the protocol inventory.
+Duplicate or malformed families fail immediately. `require()` handles sync and
+stream execution. `requireAsync()` is required only for asynchronous job
+families.
+
+TokenForge Hosts normally obtain the Registry from the coherent built-in suite:
+
+```ts
+import { createBuiltinTokenForgeProtocolSuiteV1 } from '@skyold/provider-adapters';
+import { createProtocolEngineV1 } from '@skyold/protocol-engine';
+
+const suite = createBuiltinTokenForgeProtocolSuiteV1();
+const engine = createProtocolEngineV1({ registry: suite.registry });
+console.log(engine.apiVersion);
+console.log(engine.protocolFamilies);
+```
+
+`engine.protocolFamilies` is the authoritative runtime inventory; do not copy a
+separate protocol allowlist into a Host.
+
+### Target binding
+
+```ts
+const binding = createProtocolEngineTargetBindingV1({
+  target: {
+    provider: 'opaque-provider-identity',
+    providerModel: 'resolved-provider-model',
+    connectionRef: 'host-owned-connection-reference',
+    capability: resolvedProtocolCapability,
+  },
+  bindTransport: (signal) => createCredentialBoundTransport({ resolvedConnection, signal }),
+});
+```
+
+The Host must finish authentication, routing, target selection, credential
+lookup, URL safety policy, and governance before creating this binding. The
+binding rejects connection-reference substitution before credentials or
+network access are possible. Never store a tenant/account-specific Transport
+inside a shared Registry or Engine.
+
+### `engine.execute`
+
+```ts
+const execution = await engine.execute({
+  binding,
+  task,
+  signal,
+  // preparedMedia,       // optional image-edit media prepared by the Host
+  // providerCallbackUrl, // optional async Provider callback selected by the Host
+});
+```
+
+| Input                 | Meaning                                                                                                    |
+| --------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `binding`             | Resolved target plus request-bound Transport binder.                                                       |
+| `task`                | Normalized `TaskEnvelopeV2`; raw HTTP requests do not enter the Engine.                                    |
+| `signal`              | Request cancellation signal propagated to Transport and stream/async start.                                |
+| `preparedMedia`       | Optional bounded, validated media streams used by protocols such as image editing.                         |
+| `providerCallbackUrl` | Optional async-job callback URL; lifecycle persistence and callback handling remain Host responsibilities. |
+
+Handle the complete discriminated union rather than assuming every model is a
+synchronous Chat model:
+
+```ts
+switch (execution.kind) {
+  case 'response': {
+    consumeTerminal(execution.terminal);
+    break;
+  }
+  case 'stream': {
+    try {
+      for await (const event of execution.events) consumeNormalizedEvent(event);
+      consumeTerminal(await execution.terminal);
+    } catch (error) {
+      execution.abort(error);
+      throw error;
+    }
+    break;
+  }
+  case 'accepted-job': {
+    persistAcceptedJob(execution.providerJobId);
+    break;
+  }
+  case 'rejected': {
+    recordRejectedStart(execution.failureCode, execution.acceptance.state);
+    break;
+  }
+}
+```
+
+`response` and `stream` terminal facts are already normalized and runtime
+validated. `accepted-job` means the Provider durably accepted the job.
+`rejected` includes both known rejection and acceptance-unknown; a Host must not
+blindly retry an acceptance-unknown create because that can duplicate work.
+
+### `engine.jobs`
+
+Use the same target binding for the Provider job that was previously accepted:
+
+```ts
+const observation = await engine.jobs.get({ binding, providerJobId, signal });
+
+const page = await engine.jobs.list({
+  binding,
+  pageNum: 1,
+  pageSize: 20,
+  signal,
+});
+
+await engine.jobs.cancel({ binding, providerJobId, signal });
+```
+
+The Engine validates returned snapshots and lists. Job ownership, persistence,
+polling schedules, callback reconciliation, result materialization, usage, and
+settlement remain Host-owned.
+
+### Failure behavior
+
+Invalid Registry inventories, target/task mismatches, unsupported capabilities,
+connection substitution, malformed Adapter output, and Transport binding
+failures reject the operation before unsafe facts reach the Host. Every Engine
+operation failure uses `ProtocolEngineErrorV1` with the same
+`tokenforge-protocol-engine/v1` API version, a stable `code`, and one structural
+phase: `configuration`, `input`, `transport`, `adapter`, or `lifecycle`.
+
+```ts
+try {
+  await engine.execute({ binding, task, signal });
+} catch (error) {
+  if (!isProtocolEngineErrorV1(error)) throw error;
+  hostMapEngineFailure(error.code, error.phase);
+}
+```
+
+`cause` is diagnostic-only and can contain Host Transport or Adapter details;
+never serialize it or a raw exception message to clients. The enumerable public
+classification does not include Provider payloads, credentials, retry policy,
+HTTP status, tenant facts, usage, pricing, or settlement decisions. Hosts own
+those mappings. Historical fixed-runtime messages remain temporarily compatible,
+but new integrations must switch on `code`, never `message`.
+
+The Engine validates the normalized task against the resolved capability,
+selects the protocol Adapter, and returns one versioned execution start:
+
+- `response` for synchronous terminal execution;
+- `stream` for normalized events, a terminal promise, and cancellation;
+- `accepted-job` for durable asynchronous Provider acceptance;
+- `rejected` for not-accepted or acceptance-unknown asynchronous starts.
+
+Use `engine.jobs.get`, `engine.jobs.list`, and `engine.jobs.cancel` for later
+async-job operations. Persistence, polling, callbacks, materialization, usage,
+and settlement remain Host responsibilities.
+
+An async Adapter factory declares its supported follow-up operations with
+`jobOperations`. The Engine rejects an undeclared operation with
+`PROTOCOL_ENGINE_CAPABILITY_UNSUPPORTED` before binding a Transport. Protocols
+therefore keep their real lifecycle differences: for example, a protocol may
+support `get` without pretending to support `list` or `cancel`.
+
+### Provider response compatibility
+
+Provider wire responses are an open-world boundary. An Adapter validates and
+extracts the fields understood by its protocol version, ignores additive fields
+in synchronous bodies and known stream frames, and never retains those unknown
+fields in normalized output. This lets a Provider add response metadata without
+breaking an otherwise compatible protocol implementation.
+
+Compatibility does not turn malformed known facts into success. Missing,
+mistyped, conflicting, duplicated, unsafe, or semantically invalid known fields
+still fail. An unknown stream event kind can alter lifecycle semantics, so it is
+not treated as a harmless additive field and fails unless the protocol Adapter
+explicitly supports it. Parser depth, body-size, URL, base64, index, usage, and
+terminal-consistency limits remain enforced.
+
+The Engine then validates Adapter outputs before exposing them to a Host. This
+includes sync/stream acceptance, terminal structure and consistency, every
+normalized stream event, plus async start, snapshot, and list result structure.
+Normalized event, metadata, terminal, result, usage, Responses, and async-job
+objects are closed schemas: undeclared fields are rejected. Raw Provider
+extensions therefore cannot leak through an Adapter to Host egress, usage, or
+settlement.
+
+Terminal results must match the requested Task kind, and duplicate result,
+terminal, and Responses usage facts must agree when present. A custom Adapter
+therefore cannot rely on TypeScript casts to bypass the V1 runtime contract or
+make Host egress and settlement observe different facts.
+
+## Extension rule
+
+A new protocol implements the shared ingress/egress Codec and Adapter factory
+contracts, registers Host Transport metadata, and includes them in one coherent
+Protocol Suite. Engine core must not gain Provider-name, model-name, tenant, or
+Host-framework branches. Embedded consumers may inject a custom Registry;
+The TokenForge repository provides `createBuiltinTokenForgeProtocolSuiteV1()`
+from `@skyold/provider-adapters` as its built-in implementation. Custom suites use
+`createTokenForgeProtocolSuiteV1()`, which validates Adapter/Transport and
+direct Ingress/Egress inventories before an Engine can consume the Registry.
+TokenForge's built-in composition additionally declares direct-HTTP
+participation beside each Adapter/Transport entry and rejects a declaration /
+Codec inventory mismatch. Every embedding integration performs only Registry
+lookup; a new protocol must not add an application-type or Host protocol-family
+branch.
+
+Consumers import only the `@skyold/protocol-engine` package root. Internal
+source or build subpaths are not part of V1 and are rejected by the repository
+architecture gate. The packed artifact allowlists only the five production
+modules behind that root plus the English and Simplified Chinese manuals; tests
+and other repository internals are not shipped.
+
+The stable contract identifier is `tokenforge-protocol-engine/v1`. Breaking
+contract changes require a new API version rather than changing V1 semantics.
+
+## Testing and proof levels
+
+No test suite can mathematically guarantee all future Engine functionality.
+TokenForge uses separate proof layers so a narrow unit test is not mistaken for
+complete proxy evidence.
+
+| Layer                       | Command                                                                                                                                                   | What it proves                                                                                                 | What it does not prove                                         |
+| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
+| Engine package              | `pnpm --dir packages/protocol-engine check`                                                                                                               | Independent build plus core Registry, binding, sync, stream, async-job, validation and Host-equivalence tests. | Concrete Adapter wire formats, Host persistence, live network. |
+| Built-in conformance        | `pnpm --filter @skyold/provider-adapters test -- src/conformance/runtime-conformance.test.ts`                                                             | Every registered built-in family executes through public Engine API with fixture Transports.                   | Provider credentials or current remote behavior.               |
+| Architecture boundary       | `pnpm --filter @tokenforge/acceptance test -- src/L1-kernel/import-boundary.test.ts`                                                                      | Engine dependency isolation, package surface, no raw-forward/direct Adapter bypass, Host neutrality.           | Runtime semantic correctness by itself.                        |
+| Host integration            | Targeted suites for each embedding application and repository `pnpm check`                                                                                | Caller-specific context binding, streams, media persistence, usage and settlement compatibility.               | Exact deployed SHA or live Provider availability.              |
+| Real Provider certification | `pnpm certify:protocol-engine-real --manifest /protected/path/suite.json --run --env-file .env --ack-real-provider-calls I_AUTHORIZE_REAL_PROVIDER_CALLS` | Current authenticated Provider behavior for every successful evidence shard.                                   | Deployment, billing correctness, or a missing family.          |
+
+For a local Engine change, the minimum independent gate is the Engine package
+command. A protocol or Adapter change must also pass built-in conformance. A
+Host integration change must additionally pass the affected Host suites. The
+full goal is not complete until the Registry inventory has successful real
+Provider evidence and the exact delivered SHA passes its CI and deployment
+gates.
+
+## Real-Provider certification
+
+The repository's opt-in certification Host drives this public Engine API and
+the built-in Adapter Registry directly; it does not enter through any product
+application route. A versioned JSON manifest supplies one or more cases for every
+protocol family returned by `engine.protocolFamilies`, with resolved target and
+capability facts, normalized tasks, secret environment-variable names, exact
+Provider domains, and suite request/time ceilings. Pricing and Provider billing
+are deliberately absent from both the Engine contract and certification facts.
+
+Validation is offline and is the default:
+
+```bash
+pnpm certify:protocol-engine-real --manifest /protected/path/suite.json
+```
+
+Real execution additionally requires `--run`, an environment file, and the
+exact CLI authorization
+`--ack-real-provider-calls I_AUTHORIZE_REAL_PROVIDER_CALLS`. The CLI derives the
+runtime domain allowlist from the already validated manifest and loads every
+named key through its environment reference. The runner rejects private or
+metadata network targets, cross-origin redirects, incomplete protocol
+coverage, and request/time ceiling violations. It never prints prompts, keys,
+Provider request IDs, job IDs, Provider names, or model names; durable evidence
+is mode `0600` and contains only protocol facts, terminal state, numeric usage,
+counts, and truncated SHA-256 fingerprints.
+Generated manifests set the request ceiling to the exact worst case derived
+from their cases. CLI summaries report execution starts separately from async
+job list/get observation requests; neither field is a price, rate card, or
+settlement input.
+Cancellation is intentionally absent because it can destroy an externally
+created job; it remains a separately authorized Provider lifecycle check.
+
+```bash
+pnpm certify:protocol-engine-real --manifest /protected/path/suite.json --run \
+  --env-file .env \
+  --ack-real-provider-calls I_AUTHORIZE_REAL_PROVIDER_CALLS
+```
+
+Passing local validation proves that the suite is structurally ready, not that
+any Provider was called. Only a completed `--run` artifact is real-Provider
+evidence.
+
+For a list-capable async target that has already been accepted, the Acceptance
+Host can perform a one-request, read-only diagnostic through `engine.jobs.list`
+without creating another task:
+
+```bash
+pnpm --filter @tokenforge/acceptance diagnose:protocol-engine-real-async \
+  --manifest /protected/path/async-shard.json \
+  --env-file /protected/path/provider.env \
+  --created-after 2026-08-18T03:00:00.000Z \
+  --ack-real-provider-calls I_AUTHORIZE_REAL_PROVIDER_CALLS
+```
+
+The diagnostic reports only protocol family, matching count, normalized status
+counts and bounded Provider error codes. It never emits Provider job IDs,
+models, URLs, response messages or bodies and cannot satisfy a certification
+gate.
+
+When a list-capable asynchronous shard stopped only because bounded polling was
+exhausted after the Provider had accepted the task, recover that exact submitted
+task without creating another one:
+
+```bash
+pnpm --filter @tokenforge/acceptance recover:protocol-engine-real-shard \
+  --manifest /protected/path/async-shard.json \
+  --failure-evidence /protected/path/polling-exhausted.json \
+  --env-file /protected/path/provider.env \
+  --output /protected/path/recovered-success.json \
+  --ack-real-provider-calls I_AUTHORIZE_REAL_PROVIDER_CALLS
+```
+
+Recovery accepts only matching polling-exhaustion evidence, performs one
+read-only `engine.jobs.list`, and requires exactly one matching job inside the
+original submission window. It never resubmits the task or emits raw job IDs.
+Only a normalized `succeeded` snapshot produces standard success evidence;
+other states remain non-success evidence.