doc(demos): enhance assistant demo #295
Open
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
…CP integration - Introduced new utility files: `assistantConstants.ts`, `mockMcp.ts`, and `responseProvider.ts` to support enhanced functionality in the assistant demo. - Updated `Assistant.vue` to utilize the new response provider and mock MCP tool, improving the interaction flow. - Revised documentation in `assistant.md` to reflect the inclusion of new demo files, ensuring comprehensive examples for users. - Updated sidebar items in theme configuration for better navigation and clarity on tool usage.
WalkthroughThe PR refactors the Assistant demo component to use a provider-based architecture with MCP (Model Context Protocol) tool integration, introduces comprehensive constants and configuration modules for UI data, and updates documentation headers for consistency. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Assistant as Assistant Component
participant Provider as Response Provider
participant API as /api/chat/completions
participant MockMCP as Mock MCP Stream
participant Tools as MCP Tools
User->>Assistant: Submit message with content
Assistant->>Provider: assistantResponseProvider(requestBody, abortSignal)
Provider->>Provider: Check for MCP trigger keywords
alt MCP Keywords Detected or Last Message is Tool
Provider->>MockMCP: mockMcpStream(requestBody, abortSignal)
MockMCP->>MockMCP: Extract search query from message
MockMCP->>Tools: Analyze for mcp_search tool call
Tools-->>MockMCP: tool_calls delta with extracted query
MockMCP-->>Provider: Yield tool_calls delta
MockMCP->>MockMCP: Generate assistant summary response
MockMCP-->>Provider: Yield assistant content with mock results
else Standard Chat Flow
Provider->>API: POST /api/chat/completions (streaming enabled)
API-->>Provider: SSE stream of chat completion
Provider->>Provider: Convert SSE to AsyncGenerator
end
Provider-->>Assistant: AsyncGenerator<ChatCompletion>
Assistant->>Assistant: Process deltas via toolPlugin
Assistant-->>User: Display response with formatted content
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
|
✅ Preview build completed successfully!
|
Contributor
📦 Package Previewpnpm add https://pkg.pr.new/opentiny/tiny-robot/@opentiny/tiny-robot@3a15fb0 pnpm add https://pkg.pr.new/opentiny/tiny-robot/@opentiny/tiny-robot-kit@3a15fb0 pnpm add https://pkg.pr.new/opentiny/tiny-robot/@opentiny/tiny-robot-svgs@3a15fb0 commit: 3a15fb0 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/demos/examples/Assistant.vue (1)
193-214:⚠️ Potential issue | 🟠 MajorGuard JSON.parse in tool handler to prevent conversation failures on invalid tool arguments.
The
|| '{}'fallback only protects againstundefinedornull, not against malformed JSON strings. If the LLM generates invalid JSON intoolCall.function.arguments,JSON.parsewill throw an unhandled exception and break the conversation.Suggested fix
toolPlugin({ getTools: async () => MCP_TOOLS, callTool: async (toolCall) => { - const args = JSON.parse(toolCall.function?.arguments || '{}') - return callMcpTool(toolCall.function?.name || '', args) + let args: Record<string, unknown> = {} + try { + args = JSON.parse(toolCall.function?.arguments || '{}') + } catch { + // keep empty args on parse failure + } + return callMcpTool(toolCall.function?.name || '', args) }, }),
🤖 Fix all issues with AI agents
In `@docs/demos/examples/assistantConstants.ts`:
- Around line 265-268: getContainerStyles currently accesses
window.self/window.top which will crash during SSR; guard access by checking
typeof window !== "undefined" (and optionally typeof window.self !==
"undefined") before using window.self/window.top and return a safe default for
SSR. Update the getContainerStyles function to perform the typeof window check
first, then use the existing self/top logic when available; ensure the function
still returns the same objects ({ height: '100vh' } or { top: '112px', height:
'calc(100vh - 112px)' }) in the appropriate branches.
In `@docs/demos/examples/responseProvider.ts`:
- Around line 83-116: After the 300ms artificial delay and before emitting the
tool_calls yield, check the request abort signal and stop early if aborted:
after the await new Promise((r) => setTimeout(r, 300)) add a guard like if
(signal?.aborted) return (or throw new DOMException('Aborted', 'AbortError')),
so the code that constructs and yields the tool_calls object (which uses id,
query, extractSearchQuery, userContent) does not run when the request was
cancelled; also ensure any timers/listeners used by that Promise are cleaned up
if you wire the signal to clearTimeout.
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.
assistantConstants.ts,mockMcp.ts, andresponseProvider.tsto support enhanced functionality in the assistant demo.Assistant.vueto utilize the new response provider and mock MCP tool, improving the interaction flow.assistant.mdto reflect the inclusion of new demo files, ensuring comprehensive examples for users.Summary by CodeRabbit
Documentation
New Features
✏️ Tip: You can customize this high-level summary in your review settings.