mcp-ui 0.1.0__tar.gz → 0.1.1__tar.gz

{mcp_ui-0.1.0 → mcp_ui-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-ui
-Version: 0.1.0
+Version: 0.1.1
 Summary: A Python SDK for building MCP UI resources (iframe, panels, text blocks, etc.) in a type-safe way.
 Project-URL: Homepage, https://github.com/jameszokah/mcp-ui
 Project-URL: Repository, https://github.com/jameszokah/mcp-ui
@@ -22,29 +22,30 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 
-
 # MCP-UI Python SDK
 
 This library is a Python port of the MCP-UI TypeScript SDK.  
-It provides strongly typed helpers for creating UI resources and UI actions in MCP servers, with good DX (developer experience), type safety, and MCP-compatible JSON output.
+It provides strongly typed helpers for creating UI resources and UI actions in MCP servers, with good type safety, and MCP-compatible JSON output.
 
 ---
 
 ## 📦 Installation
 
-\`\`\`bash
+```bash
 pip install mcp-ui
-\`\`\`
+```
 
 ---
 
 ## 🚀 Core Concepts
 
 ### What is a UI Resource?
+
 A **UI resource** is a unit of UI data (e.g., an HTML snippet, iframe, or Remote DOM script) that MCP clients can render.  
 This SDK helps you create them consistently with correct metadata and encodings.
 
 ### What is a UI Action?
+
 A **UI action result** represents an action the MCP client should take (e.g., open a link, show a prompt, call a tool).
 
 ---
@@ -55,7 +56,7 @@ A **UI action result** represents an action the MCP client should take (e.g., op
 
 #### Raw HTML
 
-\`\`\`python
+```python
 from mcp_ui import RawHtmlContent, CreateUIResourceOptions, create_ui_resource
 
 options = CreateUIResourceOptions(
@@ -66,11 +67,11 @@ options = CreateUIResourceOptions(
 
 resource = create_ui_resource(options)
 print(resource)
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "resource",
   "resource": {
@@ -81,11 +82,11 @@ print(resource)
     "_meta": null
   }
 }
-\`\`\`
+```
 
 #### External URL (iframe)
 
-\`\`\`python
+```python
 from mcp_ui import ExternalUrlContent, CreateUIResourceOptions, create_ui_resource
 
 options = CreateUIResourceOptions(
@@ -95,11 +96,11 @@ options = CreateUIResourceOptions(
 )
 
 iframe_res = create_ui_resource(options)
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "resource",
   "resource": {
@@ -110,11 +111,11 @@ iframe_res = create_ui_resource(options)
     "_meta": null
   }
 }
-\`\`\`
+```
 
 #### Remote DOM (React)
 
-\`\`\`python
+```python
 from mcp_ui import RemoteDomContent, CreateUIResourceOptions, create_ui_resource
 
 options = CreateUIResourceOptions(
@@ -124,11 +125,11 @@ options = CreateUIResourceOptions(
 )
 
 remote_res = create_ui_resource(options)
-\`\`\`
+```
 
 **Output (blob is Base64-encoded):**
 
-\`\`\`json
+```json
 {
   "type": "resource",
   "resource": {
@@ -139,7 +140,7 @@ remote_res = create_ui_resource(options)
     "_meta": null
   }
 }
-\`\`\`
+```
 
 ---
 
@@ -147,7 +148,7 @@ remote_res = create_ui_resource(options)
 
 You can attach metadata to resources. Keys are automatically prefixed with \`mcpui.dev/ui-\`.
 
-\`\`\`python
+```python
 options = CreateUIResourceOptions(
     uri="ui://demo/meta",
     content=RawHtmlContent(type="rawHtml", htmlString="<p>Meta Example</p>"),
@@ -156,11 +157,11 @@ options = CreateUIResourceOptions(
 )
 
 meta_res = create_ui_resource(options)
-\`\`\`
+```
 
-**Output includes \`_meta\`:**
+**Output includes \`\_meta\`:**
 
-\`\`\`json
+```json
 {
   "type": "resource",
   "resource": {
@@ -173,7 +174,7 @@ meta_res = create_ui_resource(options)
     }
   }
 }
-\`\`\`
+```
 
 ---
 
@@ -181,14 +182,14 @@ meta_res = create_ui_resource(options)
 
 #### Tool Call
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_tool_call
 action = ui_action_result_tool_call("searchTool", {"query": "MCP SDK"})
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "tool",
   "payload": {
@@ -196,50 +197,50 @@ action = ui_action_result_tool_call("searchTool", {"query": "MCP SDK"})
     "params": { "query": "MCP SDK" }
   }
 }
-\`\`\`
+```
 
 #### Prompt
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_prompt
 action = ui_action_result_prompt("Please confirm your choice")
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "prompt",
   "payload": { "prompt": "Please confirm your choice" }
 }
-\`\`\`
+```
 
 #### Link
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_link
 action = ui_action_result_link("https://example.com")
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "link",
   "payload": { "url": "https://example.com" }
 }
-\`\`\`
+```
 
 #### Intent
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_intent
 action = ui_action_result_intent("share", {"platform": "twitter"})
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "intent",
   "payload": {
@@ -247,40 +248,43 @@ action = ui_action_result_intent("share", {"platform": "twitter"})
     "params": { "platform": "twitter" }
   }
 }
-\`\`\`
+```
 
 #### Notification
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_notification
 action = ui_action_result_notification("Saved successfully!")
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "notify",
   "payload": { "message": "Saved successfully!" }
 }
-\`\`\`
+```
 
 ---
 
 ## 📖 API Reference
 
 ### create_ui_resource(options: CreateUIResourceOptions) → Dict[str, Any]
+
 Creates a UI resource for MCP. Returns a JSON-serializable dict.
 
 **Parameters:**
-- \`uri\`: must start with \`ui://\`
-- \`content\`: one of \`RawHtmlContent\`, \`ExternalUrlContent\`, \`RemoteDomContent\`
-- \`encoding\`: \`"text"\` or \`"blob"\`
-- \`uiMetadata\`: UI-specific metadata (auto-prefixed)
-- \`metadata\`: General metadata
-- \`resourceProps\`: Extra resource fields
+
+- `uri`: must start with `ui://`
+- `content`: one of `RawHtmlContent`, `ExternalUrlContent`, `RemoteDomContent`
+- `encoding`: `"text"` or `"blob"`
+- `uiMetadata`: UI-specific metadata (auto-prefixed)
+- `metadata`: General metadata
+- `resourceProps`: Extra resource fields
 
 **Type System:**
+
 - **Content payloads**:
   - RawHtmlContent(htmlString)
   - ExternalUrlContent(iframeUrl)
@@ -296,11 +300,11 @@ Creates a UI resource for MCP. Returns a JSON-serializable dict.
 ## ⚙️ Notes
 
 - Internally uses dataclasses for type safety, but always returns dicts (via \`asdict()\`) for MCP compatibility.
-- Enforces URI format (\`ui://\` prefix).
+- Enforces URI format (`ui://` prefix).
 - Auto-encodes blob resources in Base64.
 
 ---
 
 ## 📄 License
 
-MIT – same as the original MCP-UI SDK.
+MIT – Similar to the original MCP-UI Typescript server SDK.

{mcp_ui-0.1.0 → mcp_ui-0.1.1}/README.md

@@ -1,26 +1,27 @@
-
 # MCP-UI Python SDK
 
 This library is a Python port of the MCP-UI TypeScript SDK.  
-It provides strongly typed helpers for creating UI resources and UI actions in MCP servers, with good DX (developer experience), type safety, and MCP-compatible JSON output.
+It provides strongly typed helpers for creating UI resources and UI actions in MCP servers, with good type safety, and MCP-compatible JSON output.
 
 ---
 
 ## 📦 Installation
 
-\`\`\`bash
+```bash
 pip install mcp-ui
-\`\`\`
+```
 
 ---
 
 ## 🚀 Core Concepts
 
 ### What is a UI Resource?
+
 A **UI resource** is a unit of UI data (e.g., an HTML snippet, iframe, or Remote DOM script) that MCP clients can render.  
 This SDK helps you create them consistently with correct metadata and encodings.
 
 ### What is a UI Action?
+
 A **UI action result** represents an action the MCP client should take (e.g., open a link, show a prompt, call a tool).
 
 ---
@@ -31,7 +32,7 @@ A **UI action result** represents an action the MCP client should take (e.g., op
 
 #### Raw HTML
 
-\`\`\`python
+```python
 from mcp_ui import RawHtmlContent, CreateUIResourceOptions, create_ui_resource
 
 options = CreateUIResourceOptions(
@@ -42,11 +43,11 @@ options = CreateUIResourceOptions(
 
 resource = create_ui_resource(options)
 print(resource)
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "resource",
   "resource": {
@@ -57,11 +58,11 @@ print(resource)
     "_meta": null
   }
 }
-\`\`\`
+```
 
 #### External URL (iframe)
 
-\`\`\`python
+```python
 from mcp_ui import ExternalUrlContent, CreateUIResourceOptions, create_ui_resource
 
 options = CreateUIResourceOptions(
@@ -71,11 +72,11 @@ options = CreateUIResourceOptions(
 )
 
 iframe_res = create_ui_resource(options)
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "resource",
   "resource": {
@@ -86,11 +87,11 @@ iframe_res = create_ui_resource(options)
     "_meta": null
   }
 }
-\`\`\`
+```
 
 #### Remote DOM (React)
 
-\`\`\`python
+```python
 from mcp_ui import RemoteDomContent, CreateUIResourceOptions, create_ui_resource
 
 options = CreateUIResourceOptions(
@@ -100,11 +101,11 @@ options = CreateUIResourceOptions(
 )
 
 remote_res = create_ui_resource(options)
-\`\`\`
+```
 
 **Output (blob is Base64-encoded):**
 
-\`\`\`json
+```json
 {
   "type": "resource",
   "resource": {
@@ -115,7 +116,7 @@ remote_res = create_ui_resource(options)
     "_meta": null
   }
 }
-\`\`\`
+```
 
 ---
 
@@ -123,7 +124,7 @@ remote_res = create_ui_resource(options)
 
 You can attach metadata to resources. Keys are automatically prefixed with \`mcpui.dev/ui-\`.
 
-\`\`\`python
+```python
 options = CreateUIResourceOptions(
     uri="ui://demo/meta",
     content=RawHtmlContent(type="rawHtml", htmlString="<p>Meta Example</p>"),
@@ -132,11 +133,11 @@ options = CreateUIResourceOptions(
 )
 
 meta_res = create_ui_resource(options)
-\`\`\`
+```
 
-**Output includes \`_meta\`:**
+**Output includes \`\_meta\`:**
 
-\`\`\`json
+```json
 {
   "type": "resource",
   "resource": {
@@ -149,7 +150,7 @@ meta_res = create_ui_resource(options)
     }
   }
 }
-\`\`\`
+```
 
 ---
 
@@ -157,14 +158,14 @@ meta_res = create_ui_resource(options)
 
 #### Tool Call
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_tool_call
 action = ui_action_result_tool_call("searchTool", {"query": "MCP SDK"})
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "tool",
   "payload": {
@@ -172,50 +173,50 @@ action = ui_action_result_tool_call("searchTool", {"query": "MCP SDK"})
     "params": { "query": "MCP SDK" }
   }
 }
-\`\`\`
+```
 
 #### Prompt
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_prompt
 action = ui_action_result_prompt("Please confirm your choice")
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "prompt",
   "payload": { "prompt": "Please confirm your choice" }
 }
-\`\`\`
+```
 
 #### Link
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_link
 action = ui_action_result_link("https://example.com")
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "link",
   "payload": { "url": "https://example.com" }
 }
-\`\`\`
+```
 
 #### Intent
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_intent
 action = ui_action_result_intent("share", {"platform": "twitter"})
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "intent",
   "payload": {
@@ -223,40 +224,43 @@ action = ui_action_result_intent("share", {"platform": "twitter"})
     "params": { "platform": "twitter" }
   }
 }
-\`\`\`
+```
 
 #### Notification
 
-\`\`\`python
+```python
 from mcp_ui import ui_action_result_notification
 action = ui_action_result_notification("Saved successfully!")
-\`\`\`
+```
 
 **Output:**
 
-\`\`\`json
+```json
 {
   "type": "notify",
   "payload": { "message": "Saved successfully!" }
 }
-\`\`\`
+```
 
 ---
 
 ## 📖 API Reference
 
 ### create_ui_resource(options: CreateUIResourceOptions) → Dict[str, Any]
+
 Creates a UI resource for MCP. Returns a JSON-serializable dict.
 
 **Parameters:**
-- \`uri\`: must start with \`ui://\`
-- \`content\`: one of \`RawHtmlContent\`, \`ExternalUrlContent\`, \`RemoteDomContent\`
-- \`encoding\`: \`"text"\` or \`"blob"\`
-- \`uiMetadata\`: UI-specific metadata (auto-prefixed)
-- \`metadata\`: General metadata
-- \`resourceProps\`: Extra resource fields
+
+- `uri`: must start with `ui://`
+- `content`: one of `RawHtmlContent`, `ExternalUrlContent`, `RemoteDomContent`
+- `encoding`: `"text"` or `"blob"`
+- `uiMetadata`: UI-specific metadata (auto-prefixed)
+- `metadata`: General metadata
+- `resourceProps`: Extra resource fields
 
 **Type System:**
+
 - **Content payloads**:
   - RawHtmlContent(htmlString)
   - ExternalUrlContent(iframeUrl)
@@ -272,11 +276,11 @@ Creates a UI resource for MCP. Returns a JSON-serializable dict.
 ## ⚙️ Notes
 
 - Internally uses dataclasses for type safety, but always returns dicts (via \`asdict()\`) for MCP compatibility.
-- Enforces URI format (\`ui://\` prefix).
+- Enforces URI format (`ui://` prefix).
 - Auto-encodes blob resources in Base64.
 
 ---
 
 ## 📄 License
 
-MIT – same as the original MCP-UI SDK.
+MIT – Similar to the original MCP-UI Typescript server SDK.

{mcp_ui-0.1.0 → mcp_ui-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mcp-ui"
-version = "0.1.0"
+version = "0.1.1"
 description = "A Python SDK for building MCP UI resources (iframe, panels, text blocks, etc.) in a type-safe way."
 readme = "README.md"
 license = { text = "MIT" }