feat(models): tool calling flow diagram #1222
Merged
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
|
Mintlify preview ID generated: preview-mdrxym-1761932888-352d89c |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a Mermaid sequence diagram to the Tool Calling section of the models documentation to visually illustrate the basic tool calling flow. The diagram demonstrates how a model handles parallel tool calls and processes their results.
Key Changes
- Adds a sequence diagram showing the interaction between User, Model, and Tools
- Illustrates parallel tool execution using Mermaid's
parsyntax - Uses a weather query example consistent with the code examples later in the document
Comment on lines
+529
to
+548
| sequenceDiagram | ||
| participant U as User | ||
| participant M as Model | ||
| participant T as Tools | ||
| U->>M: "What's the weather in SF and NYC?" | ||
| M->>M: Analyze request & decide tools needed | ||
| par Parallel Tool Calls | ||
| M->>T: get_weather("San Francisco") | ||
| M->>T: get_weather("New York") | ||
| end | ||
| par Tool Execution | ||
| T-->>M: SF weather data | ||
| T-->>M: NYC weather data | ||
| end | ||
| M->>M: Process results & generate response | ||
| M->>U: "SF: 72°F sunny, NYC: 68°F cloudy" |
There was a problem hiding this comment.
[nitpick] The diagram lacks consistent styling found in other Mermaid diagrams throughout the documentation. Consider adding an init block with fontFamily, curve settings, and themeVariables as seen in agents.mdx and short-term-memory.mdx (e.g., %%{ init: { "fontFamily": "monospace", "themeVariables": {"edgeLabelBackground": "transparent"} } }%%).
lnhsingh
approved these changes
Nov 6, 2025
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 description provided.