Add ToolRuntime migration section to tools documentation #1737
Conversation
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
Adds a migration section explaining how older injection helpers (InjectedState, InjectedStore, get_runtime, etc.) map to the unified ToolRuntime API.
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.
Adds a migration section explaining how older injection helpers (InjectedState, InjectedStore, get_runtime, etc.) map to the unified ToolRuntime API.
Overview
This PR updates the Tools documentation by adding a migration section that explains how legacy injection helpers map to the new ToolRuntime API. It includes before/after examples and clarifies why the unified approach should be used going forward.
Type of change
Type: Update existing documentation
Related issues/PRs
Not applicable
Checklist
docs devsrc/docs.jsonif needed(Internal team members only / optional): Create a preview deployment as necessary using the Create Preview Branch workflow
Additional notes
Adds clarity around transitioning to ToolRuntime and consolidates several previously undocumented patterns into one unified section.