Add ExecPlan for roadmap item 1.2.3#148
Open
lodyai[bot] wants to merge 2 commits into
Open
Conversation
Draft the execution plan for demoting schema-bearing WASM retry hints to fallback diagnostics and index it from docs/contents.md. The plan captures the contract boundary, documentation updates, validation gates, and the proportionality check for rstest-bdd coverage requested for this roadmap item.
Contributor
Reviewer's GuideAdds a new ExecPlan document for roadmap item 1.2.3 (demoting schema-bearing WASM retry hints to fallback diagnostics) and indexes it from the documentation contents so it is discoverable alongside other execution plans. Sequence diagram for WASM tool retry hints as fallback diagnosticssequenceDiagram
actor User
participant LLM
participant Orchestrator
participant Worker
participant WasmWrapper
participant MetadataHelper
User->>LLM: Send reasoning request using WASM tool
LLM->>Orchestrator: Request with selected_tool
Orchestrator->>Worker: Execute tool_call
Worker->>WasmWrapper: execute_sync(request_args)
Note over Orchestrator,Worker: Schema already advertised via ToolDefinition.parameters
WasmWrapper-->>Worker: Error(ToolReturnedError)
Worker-->>Orchestrator: ToolReturnedError
Orchestrator-->>LLM: Tool error with fallback_diagnostic
rect rgb(230,230,255)
WasmWrapper->>MetadataHelper: build_fallback_diagnostic(tool_description, tool_schema, failure_reason)
MetadataHelper-->>WasmWrapper: FallbackDiagnostic(message_refers_to_advertised_schema)
end
LLM-->>User: Response including recovery guidance
Flow diagram for ExecPlan approval gates and milestones for roadmap item 1.2.3flowchart TD
A["Plan drafted
ExecPlan 1.2.3"] --> B["Approval gate:
Plan approved"]
B --> C["Milestone 1:
Confirm contract boundary
and failure language"]
C --> D["Milestone 2:
Refactor WASM fallback
diagnostic helper"]
D --> E["Milestone 3:
Unit, integration and
behavioural tests added"]
E --> F["Milestone 4:
Docs synchronized
(roadmap, RFC, guides,
architecture)"]
F --> G["Approval gate:
Implementation complete"]
G --> H["Approval gate:
Validation passed
(tests, make all,
markdownlint,
git diff --check)"]
H --> I["Approval gate:
Docs synced"]
I --> J["Milestone 5:
Record evidence and
create feature commit"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've found 3 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/execplans/1-2-3-demote-schema-bearing-retry-hints.md" line_range="93" />
<code_context>
+ `src/worker/container/tests/remote_tools.rs` already cover hosted tool
+ advertisement and remote execution. They are the best existing behavioural
+ evidence that hosted flows do not need a failure-first schema path.
+- `docs/users-guide.md` currently describes hosted advertisement of MCP and
+ WASM tools but does not yet explicitly say that retry hints are fallback
+ diagnostics only.
</code_context>
<issue_to_address>
**issue (review_instructions):** The acronym MCP is introduced without being expanded on first use, which violates the requirement to define uncommon acronyms.
Consider expanding MCP on first mention, for example: "Model Context Protocol (MCP)" before using the acronym alone in later occurrences.
<details>
<summary>Review instructions:</summary>
**Path patterns:** `**/*.md`
**Instructions:**
Define uncommon acronyms on first use.
</details>
</issue_to_address>
### Comment 2
<location path="docs/execplans/1-2-3-demote-schema-bearing-retry-hints.md" line_range="141" />
<code_context>
+ from roadmap item `1.2.4` or broader provider-shaping changes has not leaked
+ into this slice.
+- Interface: if demoting retry hints requires changing `ToolDefinition`,
+ `NativeTool`, the WIT interface, or the worker-orchestrator transport types,
+ stop and document why the existing contract cannot express the feature.
+- Behavioural drift: if preserving actionable guidance requires making retry
</code_context>
<issue_to_address>
**issue (review_instructions):** The acronym WIT is used without definition on first use, conflicting with the requirement to define uncommon acronyms.
Please expand WIT on its first occurrence, for example "WebAssembly Interface Types (WIT) interface", and then use the acronym alone subsequently.
<details>
<summary>Review instructions:</summary>
**Path patterns:** `**/*.md`
**Instructions:**
Define uncommon acronyms on first use.
</details>
</issue_to_address>
### Comment 3
<location path="docs/execplans/1-2-3-demote-schema-bearing-retry-hints.md" line_range="260" />
<code_context>
+ `src/worker/container/tests/remote_tools.rs` that proves hosted flows still
+ receive the canonical schema before any fallback path is exercised.
+
+### Behavioural coverage with `rstest-bdd` where applicable
+
+Attempt one narrow, in-process scenario only if it stays within the tolerances.
</code_context>
<issue_to_address>
**issue (review_instructions):** The acronym BDD is referenced via `rstest-bdd` without explaining what BDD stands for, which breaks the acronym-definition guideline.
Although `rstest-bdd` is a crate name, the underlying acronym BDD (behaviour-driven development) should be expanded on first mention in the surrounding prose, for example: "behaviour-driven development (BDD)".
<details>
<summary>Review instructions:</summary>
**Path patterns:** `**/*.md`
**Instructions:**
Define uncommon acronyms on first use.
</details>
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
github-actions
Bot
added
size: XS
Expand MCP, WIT, and BDD on first use in the new roadmap item 1.2.3 execution plan so the document follows the Markdown review instructions for uncommon acronyms.
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
1 participant
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.
Summary
1.2.3covering how to demote schema-bearing WASM retry hints to fallback diagnosticsdocs/contents.mdValidation
bunx markdownlint-cli2 docs/execplans/1-2-3-demote-schema-bearing-retry-hints.md docs/contents.mdgit diff --checkSummary by Sourcery
Add an execution plan document for roadmap item 1.2.3 describing how schema-bearing WASM retry hints will be demoted to fallback diagnostics and index it from the documentation contents.
Documentation: