docs: standardize UI terminology to use "view" consistently (#325)
* docs: standardize UI terminology to use "view" consistently Replaces "widget" and "Guest UI" terminology with "view" across the codebase as decided in the community survey. This change updates: - Specification document - SDK source code and JSDoc comments - Example servers and documentation - Plugin documentation and skills Closes #71 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
9e42ee05a3
commit
4fc71656a3
1 changed files with 381 additions and 393 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# QR Code MCP Server
|
||||
|
||||
A minimal Python MCP server that generates customizable QR codes with an interactive widget UI.
|
||||
A minimal Python MCP server that generates customizable QR codes with an interactive view UI.
|
||||
|
||||

|
||||
|
||||
|
|
@ -33,7 +33,7 @@ Then add to your MCP client configuration (stdio transport), replacing the path
|
|||
|
||||
- Generate QR codes from any text or URL
|
||||
- Customizable colors, size, and error correction
|
||||
- Interactive widget that displays in MCP-UI enabled clients
|
||||
- Interactive view that displays in MCP-UI enabled clients
|
||||
- Supports both HTTP (for web clients) and stdio (for MCP clients)
|
||||
|
||||
## Prerequisites
|
||||
|
|
@ -151,19 +151,19 @@ Generate a QR code with optional customization.
|
|||
```
|
||||
qr-server/
|
||||
├── server.py # MCP server (FastMCP + uvicorn, deps inline via PEP 723)
|
||||
├── widget.html # Interactive UI widget
|
||||
├── view.html # Interactive UI view
|
||||
└── README.md
|
||||
```
|
||||
|
||||
### Protocol
|
||||
|
||||
The widget uses MCP Apps SDK protocol:
|
||||
The view uses MCP Apps SDK protocol:
|
||||
|
||||
1. Widget sends `ui/initialize` request
|
||||
1. The view sends `ui/initialize` request
|
||||
2. Host responds with capabilities
|
||||
3. Widget sends `ui/notifications/initialized`
|
||||
3. The view sends `ui/notifications/initialized`
|
||||
4. Host sends `ui/notifications/tool-result` with QR image
|
||||
5. Widget renders image and sends `ui/notifications/size-changed`
|
||||
5. The view renders image and sends `ui/notifications/size-changed`
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue