docs: add dynamic tool tradeoffs for cache and model behavior [closes DOC-991]#3572
Draft
open-swe[bot] wants to merge 3 commits intomainfrom
Draft
docs: add dynamic tool tradeoffs for cache and model behavior [closes DOC-991]#3572open-swe[bot] wants to merge 3 commits intomainfrom
open-swe[bot] wants to merge 3 commits intomainfrom
Conversation
…ents page Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
…l behavior risks Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
github-actions
bot
added
external
Contributor
|
Mintlify preview ID generated: preview-opensw-1776171572-08620c3 |
Contributor
|
Mintlify preview ID generated: preview-opensw-1776172304-187a215 |
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
2 participants
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.
Description
Adds a "Tradeoffs" subsection to the dynamic tools documentation addressing common questions: (1) models may attempt to call tools that were available in earlier turns but have since been removed, (2) changing the tool list invalidates the provider's prompt cache with practical mitigation strategies, and (3) fewer tools generally means better accuracy. Also adds a Warning callout to the middleware custom docs page cross-linking to the tradeoffs section.
Resolves DOC-991
Test Plan
Opened collaboratively by Naomi Pentrel and open-swe.