mirror of
https://github.com/ggml-org/llama.cpp.git
synced 2026-06-27 23:50:20 -05:00
* webui: Move static build output from `tools/server/public` to `build/ui` directory * refactor: Move to `tools/ui` * refactor: rename CMake variables and preprocessor defines - Rename LLAMA_BUILD_WEBUI -> LLAMA_BUILD_UI (old kept as deprecated) - Rename LLAMA_USE_PREBUILT_WEBUI -> LLAMA_USE_PREBUILT_UI (old kept as deprecated) - Backward compat: old vars auto-forward to new ones with DEPRECATION warning - Rename internal vars: WEBUI_SOURCE -> UI_SOURCE, WEBUI_SOURCE_DIR -> UI_SOURCE_DIR, etc. - Rename HF bucket: LLAMA_WEBUI_HF_BUCKET -> LLAMA_UI_HF_BUCKET - Emit both LLAMA_BUILD_WEBUI and LLAMA_BUILD_UI preprocessor defines - Emit both LLAMA_WEBUI_DEFAULT_ENABLED and LLAMA_UI_DEFAULT_ENABLED * refactor: rename CLI flags (--webui -> --ui) with backward compat - Add --ui/--no-ui (old --webui/--no-webui kept as deprecated aliases) - Add --ui-config (old --webui-config kept as deprecated alias) - Add --ui-config-file (old --webui-config-file kept as deprecated alias) - Add --ui-mcp-proxy/--no-ui-mcp-proxy (old --webui-mcp-proxy kept as deprecated) - Add new env vars: LLAMA_ARG_UI, LLAMA_ARG_UI_CONFIG, LLAMA_ARG_UI_CONFIG_FILE, LLAMA_ARG_UI_MCP_PROXY - C++ struct fields: params.ui, params.ui_config_json, params.ui_mcp_proxy added alongside old fields - Backward compat: old fields synced to new ones in g_params_to_internals * refactor: update C++ server internals with backward compat - Rename json_webui_settings -> json_ui_settings (both kept in server_context_meta) - Rename params.webui usage -> params.ui (both synced, old still works) - JSON API emits both "ui"/"ui_settings" and "webui"/"webui_settings" keys - Server routes use params.ui_mcp_proxy || params.webui_mcp_proxy - Preprocessor guards use #if defined(LLAMA_BUILD_UI) || defined(LLAMA_BUILD_WEBUI) * refactor: rename CI/CD workflows, artifacts, and build script - Rename webui-build.yml -> ui-build.yml; artifact webui-build -> ui-build - Rename webui-publish.yml -> ui-publish.yml; var HF_BUCKET_WEBUI_STATIC_OUTPUT -> HF_BUCKET_UI_STATIC_OUTPUT - Rename server-webui.yml -> server-ui.yml; job webui-build/checks -> ui-build/checks - Update server.yml: job/artifact refs webui-build -> ui-build - Update release.yml: all webui-build/publish refs -> ui-build/publish; HF_TOKEN_WEBUI_STATIC_OUTPUT -> HF_TOKEN_UI_STATIC_OUTPUT - Update server-self-hosted.yml: webui-build -> ui-build - Update build-self-hosted.yml: HF_WEBUI_VERSION -> HF_UI_VERSION - Rename webui-download.cmake -> ui-download.cmake (internal refs updated) - Update labeler.yml: server/webui -> server/ui path label * docs: update CODEOWNERS and server README docs - Update CODEOWNERS: team ggml-org/llama-webui -> ggml-org/llama-ui, path /tools/server/webui/ -> /tools/ui/ - Update server README.md: CLI tables show --ui flags with deprecated --webui aliases - Update server README-dev.md: "WebUI" -> "UI", paths updated to tools/ui/ * fix: Small fixes for UI build * fix: CMake.txt syntax * chore: Formatting * fix: `.editorconfig` for llama-ui * chore: Formatting * refactor: Use `APP_NAME` in Error route * refactor: Cleanup * refactor: Single migration service * make llama-ui a linkable target * fix: UI Build output * fix: Missing change * fix: separate llama-ui npm build output into build/tools/ui/dist subfolder + use cmake npm build instead of downloading ui-build.yml artifacts in CI * refactor: UI workflows cleanup --------- Co-authored-by: Xuan Son Nguyen <son@huggingface.co>
227 lines
10 KiB
Markdown
227 lines
10 KiB
Markdown
```mermaid
|
||
sequenceDiagram
|
||
participant UI as 🧩 McpServersSettings / ChatForm
|
||
participant chatStore as 🗄️ chatStore
|
||
participant mcpStore as 🗄️ mcpStore
|
||
participant mcpResStore as 🗄️ mcpResourceStore
|
||
participant convStore as 🗄️ conversationsStore
|
||
participant MCPSvc as ⚙️ MCPService
|
||
participant LS as 💾 LocalStorage
|
||
participant ExtMCP as 🔌 External MCP Server
|
||
|
||
Note over mcpStore: State:<br/>isInitializing, error<br/>toolCount, connectedServers<br/>healthChecks (Map)<br/>connections (Map)<br/>toolsIndex (Map)<br/>serverConfigs (Map)
|
||
|
||
Note over mcpResStore: State:<br/>serverResources (Map)<br/>cachedResources (Map)<br/>subscriptions (Map)<br/>attachments[]
|
||
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
Note over UI,ExtMCP: 🚀 INITIALIZATION (App Startup)
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
|
||
UI->>mcpStore: ensureInitialized()
|
||
activate mcpStore
|
||
|
||
mcpStore->>LS: get(MCP_SERVERS_LOCALSTORAGE_KEY)
|
||
LS-->>mcpStore: MCPServerSettingsEntry[]
|
||
|
||
mcpStore->>mcpStore: parseServerSettings(servers)
|
||
Note right of mcpStore: Filter enabled servers<br/>Build MCPServerConfig objects<br/>Per-chat overrides checked via convStore
|
||
|
||
loop For each enabled server
|
||
mcpStore->>mcpStore: runHealthCheck(serverId)
|
||
mcpStore->>mcpStore: updateHealthCheck(id, CONNECTING)
|
||
|
||
mcpStore->>MCPSvc: connect(serverName, config, clientInfo, capabilities, onPhase)
|
||
activate MCPSvc
|
||
|
||
MCPSvc->>MCPSvc: createTransport(config)
|
||
Note right of MCPSvc: WebSocket / StreamableHTTP / SSE<br/>with optional CORS proxy
|
||
|
||
MCPSvc->>ExtMCP: Transport handshake
|
||
ExtMCP-->>MCPSvc: Connection established
|
||
|
||
MCPSvc->>ExtMCP: Initialize request
|
||
Note right of ExtMCP: Exchange capabilities<br/>Server info, protocol version
|
||
|
||
ExtMCP-->>MCPSvc: InitializeResult (serverInfo, capabilities)
|
||
|
||
MCPSvc->>ExtMCP: listTools()
|
||
ExtMCP-->>MCPSvc: Tool[]
|
||
|
||
MCPSvc-->>mcpStore: MCPConnection
|
||
deactivate MCPSvc
|
||
|
||
mcpStore->>mcpStore: connections.set(serverName, connection)
|
||
mcpStore->>mcpStore: indexTools(connection.tools, serverName)
|
||
Note right of mcpStore: toolsIndex.set(toolName, serverName)<br/>Handle name conflicts with prefixes
|
||
|
||
mcpStore->>mcpStore: updateHealthCheck(id, SUCCESS)
|
||
mcpStore->>mcpStore: _connectedServers.push(serverName)
|
||
|
||
alt Server supports resources
|
||
mcpStore->>MCPSvc: listAllResources(connection)
|
||
MCPSvc->>ExtMCP: listResources()
|
||
ExtMCP-->>MCPSvc: MCPResource[]
|
||
MCPSvc-->>mcpStore: resources
|
||
|
||
mcpStore->>MCPSvc: listAllResourceTemplates(connection)
|
||
MCPSvc->>ExtMCP: listResourceTemplates()
|
||
ExtMCP-->>MCPSvc: MCPResourceTemplate[]
|
||
MCPSvc-->>mcpStore: templates
|
||
|
||
mcpStore->>mcpResStore: setServerResources(serverName, resources, templates)
|
||
end
|
||
end
|
||
|
||
mcpStore->>mcpStore: _isInitializing = false
|
||
deactivate mcpStore
|
||
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
Note over UI,ExtMCP: 🔧 TOOL EXECUTION (Chat with Tools)
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
|
||
UI->>mcpStore: executeTool(mcpCall: MCPToolCall, signal?)
|
||
activate mcpStore
|
||
|
||
mcpStore->>mcpStore: toolsIndex.get(mcpCall.function.name)
|
||
Note right of mcpStore: Resolve serverName from toolsIndex<br/>MCPToolCall = {id, type, function: {name, arguments}}
|
||
|
||
mcpStore->>mcpStore: acquireConnection()
|
||
Note right of mcpStore: activeFlowCount++<br/>Prevent shutdown during execution
|
||
|
||
mcpStore->>mcpStore: connection = connections.get(serverName)
|
||
|
||
mcpStore->>MCPSvc: callTool(connection, {name, arguments}, signal)
|
||
activate MCPSvc
|
||
|
||
MCPSvc->>MCPSvc: throwIfAborted(signal)
|
||
MCPSvc->>ExtMCP: callTool(name, arguments)
|
||
|
||
alt Tool execution success
|
||
ExtMCP-->>MCPSvc: ToolCallResult (content, isError)
|
||
MCPSvc->>MCPSvc: formatToolResult(result)
|
||
Note right of MCPSvc: Handle text, image (base64),<br/>embedded resource content
|
||
MCPSvc-->>mcpStore: ToolExecutionResult
|
||
else Tool execution error
|
||
ExtMCP-->>MCPSvc: Error
|
||
MCPSvc-->>mcpStore: throw Error
|
||
else Aborted
|
||
MCPSvc-->>mcpStore: throw AbortError
|
||
end
|
||
|
||
deactivate MCPSvc
|
||
|
||
mcpStore->>mcpStore: releaseConnection()
|
||
Note right of mcpStore: activeFlowCount--
|
||
|
||
mcpStore-->>UI: ToolExecutionResult
|
||
deactivate mcpStore
|
||
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
Note over UI,ExtMCP: <20> RESOURCE ATTACHMENT CONSUMPTION
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
|
||
chatStore->>mcpStore: consumeResourceAttachmentsAsExtras()
|
||
activate mcpStore
|
||
mcpStore->>mcpResStore: getAttachments()
|
||
mcpResStore-->>mcpStore: MCPResourceAttachment[]
|
||
mcpStore->>mcpStore: Convert attachments to message extras
|
||
mcpStore->>mcpResStore: clearAttachments()
|
||
mcpStore-->>chatStore: MessageExtra[] (for user message)
|
||
deactivate mcpStore
|
||
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
Note over UI,ExtMCP: <20>📝 PROMPT OPERATIONS
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
|
||
UI->>mcpStore: getAllPrompts()
|
||
activate mcpStore
|
||
|
||
loop For each connected server with prompts capability
|
||
mcpStore->>MCPSvc: listPrompts(connection)
|
||
MCPSvc->>ExtMCP: listPrompts()
|
||
ExtMCP-->>MCPSvc: Prompt[]
|
||
MCPSvc-->>mcpStore: prompts
|
||
end
|
||
|
||
mcpStore-->>UI: MCPPromptInfo[] (with serverName)
|
||
deactivate mcpStore
|
||
|
||
UI->>mcpStore: getPrompt(serverName, promptName, args?)
|
||
activate mcpStore
|
||
|
||
mcpStore->>MCPSvc: getPrompt(connection, name, args)
|
||
MCPSvc->>ExtMCP: getPrompt({name, arguments})
|
||
ExtMCP-->>MCPSvc: GetPromptResult (messages)
|
||
MCPSvc-->>mcpStore: GetPromptResult
|
||
|
||
mcpStore-->>UI: GetPromptResult
|
||
deactivate mcpStore
|
||
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
Note over UI,ExtMCP: 📁 RESOURCE OPERATIONS
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
|
||
UI->>mcpResStore: addAttachment(resourceInfo)
|
||
activate mcpResStore
|
||
mcpResStore->>mcpResStore: Create MCPResourceAttachment (loading: true)
|
||
mcpResStore-->>UI: attachment
|
||
|
||
UI->>mcpStore: readResource(serverName, uri)
|
||
activate mcpStore
|
||
|
||
mcpStore->>MCPSvc: readResource(connection, uri)
|
||
MCPSvc->>ExtMCP: readResource({uri})
|
||
ExtMCP-->>MCPSvc: MCPReadResourceResult (contents)
|
||
MCPSvc-->>mcpStore: contents
|
||
|
||
mcpStore-->>UI: MCPResourceContent[]
|
||
deactivate mcpStore
|
||
|
||
UI->>mcpResStore: updateAttachmentContent(attachmentId, content)
|
||
mcpResStore->>mcpResStore: cacheResourceContent(resource, content)
|
||
deactivate mcpResStore
|
||
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
Note over UI,ExtMCP: 🔄 AUTO-RECONNECTION
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
|
||
Note over mcpStore: On WebSocket close or connection error:
|
||
mcpStore->>mcpStore: autoReconnect(serverName, attempt)
|
||
activate mcpStore
|
||
|
||
mcpStore->>mcpStore: Calculate backoff delay
|
||
Note right of mcpStore: delay = min(30s, 1s * 2^attempt)
|
||
|
||
mcpStore->>mcpStore: Wait for delay
|
||
mcpStore->>mcpStore: reconnectServer(serverName)
|
||
|
||
alt Reconnection success
|
||
mcpStore->>mcpStore: updateHealthCheck(id, SUCCESS)
|
||
else Max attempts reached
|
||
mcpStore->>mcpStore: updateHealthCheck(id, ERROR)
|
||
end
|
||
deactivate mcpStore
|
||
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
Note over UI,ExtMCP: 🛑 SHUTDOWN
|
||
%% ═══════════════════════════════════════════════════════════════════════════
|
||
|
||
UI->>mcpStore: shutdown()
|
||
activate mcpStore
|
||
|
||
mcpStore->>mcpStore: Wait for activeFlowCount == 0
|
||
|
||
loop For each connection
|
||
mcpStore->>MCPSvc: disconnect(connection)
|
||
MCPSvc->>MCPSvc: transport.onclose = undefined
|
||
MCPSvc->>ExtMCP: close()
|
||
end
|
||
|
||
mcpStore->>mcpStore: connections.clear()
|
||
mcpStore->>mcpStore: toolsIndex.clear()
|
||
mcpStore->>mcpStore: _connectedServers = []
|
||
|
||
mcpStore->>mcpResStore: clear()
|
||
deactivate mcpStore
|
||
```
|