docs: document tool runtime bridge continuation#231
Draft
cursor[bot] wants to merge 1 commit into
Draft
Conversation
Co-authored-by: Sara Loera <saraeloop@users.noreply.github.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🧠 Noēsis Pull Request
Overview
Documents the tool-contract runtime bridge continuation path for approval-gated subprocess tools, including how prepared drafts pause episodes and how
ns.resume_run(...)resumes the same draft after approval.Type of Change
Motivation & Context
Recent runtime bridge guardrails make subprocess-only prepared invocation continuation explicit in source and tests, but the docs did not fully explain the bridge entry points, resume behavior, operational inspection paths, or failure modes. This PR updates existing docs instead of adding a redundant page.
Technical Details
Docs added/updated:
docs/guides/integrate-adapters.mdx: Adds the episode runtime bridge entry points, pause/resume flow, event ordering, identity rules, and troubleshooting cases.docs/reference/python-api.mdx: References runtime bridge helpers and typed bridge errors for adapter implementers.docs/explanation/artifacts.mdx: Addsfinal.json,checkpoints/, andtool_invocations/{prepared,approvals,idempotency}/to the artifact layout, plus paused-vs-terminal constraints.docs/guides/human-in-the-loop.mdx: Cross-links human approval guidance to the prepared invocation bridge.Codepaths covered:
noesis.usecases.tool_invocation.runtime_bridge.ToolRuntimeBridgePortsbuild_tool_invocation_actuation_bindings(...)build_resumed_tool_invocation_actuation_bindings(...)ToolContractContinuationActuatornoesis.core.resume_run(...)pending-draft continuation wiringnoesis.infrastructure.tool_invocation.repositoriesKey knowledge gaps addressed:
final.json/manifest.jsonartifacts.ns.resume_run(...)resumes the existing draft without re-preparing it.run.resumemutation.Validation
Required
uv run pytest) or equivalent targeted suiteSituational
pnpm run buildin docs/)python scripts/pre_release.py --check-all)Validation performed:
python3 -m pytest tests/runtime/test_tool_invocation_runtime_bridge.py -qinitially could not run because the base Python environment had nopytest.python3.12-venv, created/tmp/noesis-docs-venv-2, installed.[dev], then ran/tmp/noesis-docs-venv-2/bin/python -m pytest tests/runtime/test_tool_invocation_runtime_bridge.py -q->8 passed in 0.55s.npx --yes mintlify@latest broken-linksfromdocs/->success no broken links found.Notes:
docs/package.json, so there is nopnpm run buildcommand to run. Mintlify link validation was the available docs validation.ADR-003 Schema Governance Checklist
$schema_versionbumped for every artifact whose stable fields changeddocs/schema/**regenerated (no diff afterpython scripts/gen_schema.py)internal_docs/schema/kpi*.yamlMIGRATIONS.schema.mdorMIGRATIONS.kpi.mdpython scripts/schema_guard.py --strict --jsonpasses locallydocs/app/reference/*updated when new fields/KPIs surface to usersNot applicable: documentation-only change; no schema fields changed.
Observability & Safety
Improves operational safety docs for approval-gated side effects by documenting the evidence chain, paused-run artifact expectations, and fail-fast protocol guardrails.
Educational / Research Value
Clarifies the ADR-016 prepared tool invocation model for adapter implementers and operators inspecting interrupted runs.
Screenshots / Logs
Related Issues / References