Skip to content

Commit 1ddfe41

Browse files
committed
fix: improve README gallery layout
- Fix uneven column widths by using minimal separator - Move Starter Templates to separate 2-cell table with description - Add screenshot.png to top of each example README (13 examples) - Shorten tooltips for cleaner table
1 parent 8762b67 commit 1ddfe41

14 files changed

Lines changed: 84 additions & 22 deletions

File tree

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,22 @@
44

55
## Example Gallery
66

7-
| | | |
8-
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
9-
| [![Map](examples/map-server/grid-cell.png "Interactive 3D globe viewer using CesiumJS with OpenStreetMap tiles")](examples/map-server) | [![Three.js](examples/threejs-server/grid-cell.png "Interactive 3D scene renderer using Three.js")](examples/threejs-server) | [![ShaderToy](examples/shadertoy-server/grid-cell.png "Real-time GLSL fragment shader renderer using WebGL 2.0")](examples/shadertoy-server) |
10-
| [**Map**](examples/map-server) | [**Three.js**](examples/threejs-server) | [**ShaderToy**](examples/shadertoy-server) |
11-
| [![Sheet Music](examples/sheet-music-server/grid-cell.png "Renders ABC notation as sheet music with audio playback")](examples/sheet-music-server) | [![Wiki Explorer](examples/wiki-explorer-server/grid-cell.png "Visualizes Wikipedia link graphs using force-directed layout")](examples/wiki-explorer-server) | [![Cohort Heatmap](examples/cohort-heatmap-server/grid-cell.png "Interactive heatmap showing customer retention over time")](examples/cohort-heatmap-server) |
12-
| [**Sheet Music**](examples/sheet-music-server) | [**Wiki Explorer**](examples/wiki-explorer-server) | [**Cohort Heatmap**](examples/cohort-heatmap-server) |
13-
| [![Scenario Modeler](examples/scenario-modeler-server/grid-cell.png "SaaS business parameter modeling with 12-month projections")](examples/scenario-modeler-server) | [![Budget Allocator](examples/budget-allocator-server/grid-cell.png "Interactive budget allocation with real-time visualization")](examples/budget-allocator-server) | [![Customer Segmentation](examples/customer-segmentation-server/grid-cell.png "Interactive scatter/bubble chart with segment clustering")](examples/customer-segmentation-server) |
14-
| [**Scenario Modeler**](examples/scenario-modeler-server) | [**Budget Allocator**](examples/budget-allocator-server) | [**Customer Segmentation**](examples/customer-segmentation-server) |
15-
| [![System Monitor](examples/system-monitor-server/grid-cell.png "Real-time OS metrics with CPU and memory charts")](examples/system-monitor-server) | [![Transcript](examples/transcript-server/grid-cell.png "Live speech transcription using Web Speech API")](examples/transcript-server) | [![Video Resource](examples/video-resource-server/grid-cell.png "Demonstrates serving binary video content via MCP resources")](examples/video-resource-server) |
16-
| [**System Monitor**](examples/system-monitor-server) | [**Transcript**](examples/transcript-server) | [**Video Resource**](examples/video-resource-server) |
17-
| [![Basic](examples/basic-server-react/grid-cell.png "Starter template: MCP App with your choice of framework")](examples/basic-server-react) | **Starter Templates** — The same app built with different frameworks. Pick your favorite! | |
18-
| [React](examples/basic-server-react) · [Vue](examples/basic-server-vue) · [Svelte](examples/basic-server-svelte) · [Preact](examples/basic-server-preact) · [Solid](examples/basic-server-solid) · [Vanilla JS](examples/basic-server-vanillajs) | | |
7+
| | | |
8+
|:---:|:---:|:---:|
9+
| [![Map](examples/map-server/grid-cell.png "Interactive 3D globe viewer using CesiumJS")](examples/map-server) | [![Three.js](examples/threejs-server/grid-cell.png "Interactive 3D scene renderer")](examples/threejs-server) | [![ShaderToy](examples/shadertoy-server/grid-cell.png "Real-time GLSL shader renderer")](examples/shadertoy-server) |
10+
| [**Map**](examples/map-server) | [**Three.js**](examples/threejs-server) | [**ShaderToy**](examples/shadertoy-server) |
11+
| [![Sheet Music](examples/sheet-music-server/grid-cell.png "ABC notation to sheet music")](examples/sheet-music-server) | [![Wiki Explorer](examples/wiki-explorer-server/grid-cell.png "Wikipedia link graph visualization")](examples/wiki-explorer-server) | [![Cohort Heatmap](examples/cohort-heatmap-server/grid-cell.png "Customer retention heatmap")](examples/cohort-heatmap-server) |
12+
| [**Sheet Music**](examples/sheet-music-server) | [**Wiki Explorer**](examples/wiki-explorer-server) | [**Cohort Heatmap**](examples/cohort-heatmap-server) |
13+
| [![Scenario Modeler](examples/scenario-modeler-server/grid-cell.png "SaaS business projections")](examples/scenario-modeler-server) | [![Budget Allocator](examples/budget-allocator-server/grid-cell.png "Interactive budget allocation")](examples/budget-allocator-server) | [![Customer Segmentation](examples/customer-segmentation-server/grid-cell.png "Scatter chart with clustering")](examples/customer-segmentation-server) |
14+
| [**Scenario Modeler**](examples/scenario-modeler-server) | [**Budget Allocator**](examples/budget-allocator-server) | [**Customer Segmentation**](examples/customer-segmentation-server) |
15+
| [![System Monitor](examples/system-monitor-server/grid-cell.png "Real-time OS metrics")](examples/system-monitor-server) | [![Transcript](examples/transcript-server/grid-cell.png "Live speech transcription")](examples/transcript-server) | [![Video Resource](examples/video-resource-server/grid-cell.png "Binary video via MCP resources")](examples/video-resource-server) |
16+
| [**System Monitor**](examples/system-monitor-server) | [**Transcript**](examples/transcript-server) | [**Video Resource**](examples/video-resource-server) |
17+
18+
### Starter Templates
19+
20+
| | |
21+
|:---:|:---|
22+
| [![Basic](examples/basic-server-react/grid-cell.png "Starter template")](examples/basic-server-react) | The same app built with different frameworks — pick your favorite!<br><br>[React](examples/basic-server-react) · [Vue](examples/basic-server-vue) · [Svelte](examples/basic-server-svelte) · [Preact](examples/basic-server-preact) · [Solid](examples/basic-server-solid) · [Vanilla JS](examples/basic-server-vanillajs) |
1923

2024
This repo contains the SDK and [specification](https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/draft/apps.mdx) for MCP Apps Extension ([SEP-1865](https://github.com/modelcontextprotocol/modelcontextprotocol/pull/1865)).
2125

examples/basic-server-react/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example: Basic Server (React)
22

3+
![Screenshot](screenshot.png)
4+
35
An MCP App example with a React UI.
46

57
> [!TIP]

examples/budget-allocator-server/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example: Budget Allocator App
22

3+
![Screenshot](screenshot.png)
4+
35
An interactive budget allocation tool demonstrating real-time data visualization with MCP Apps.
46

57
<table>

examples/cohort-heatmap-server/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example: Cohort Heatmap App
22

3+
![Screenshot](screenshot.png)
4+
35
A demo MCP App that displays cohort retention data as an interactive heatmap, showing customer retention over time by signup month.
46

57
<table>

examples/customer-segmentation-server/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example: Customer Segmentation Explorer
22

3+
![Screenshot](screenshot.png)
4+
35
A demo MCP App that displays customer data as an interactive scatter/bubble chart with segment-based clustering. Users can explore different metrics, filter by segment, and click to see detailed customer information.
46

57
<table>

examples/map-server/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example: Interactive Map
22

3+
![Screenshot](screenshot.png)
4+
35
Interactive 3D globe viewer using CesiumJS with OpenStreetMap tiles. Demonstrates geocoding integration and full MCP App capabilities.
46

57
## Features

examples/scenario-modeler-server/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example: SaaS Scenario Modeler
22

3+
![Screenshot](screenshot.png)
4+
35
A React-based demo MCP App that lets users adjust SaaS business parameters and see real-time 12-month projections of revenue, costs, and profitability with comparison against pre-built scenario templates.
46

57
<table>

examples/shadertoy-server/README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example: ShaderToy Server
22

3+
![Screenshot](screenshot.png)
4+
35
A demo MCP App that renders [ShaderToy](https://www.shadertoy.com/)-compatible GLSL fragment shaders in real-time using WebGL 2.0 and [ShaderToyLite.js](https://github.com/nickoala/ShaderToyLite).
46

57
<table>
@@ -50,7 +52,10 @@ _Tool input:_
5052

5153
```json
5254
{
53-
"fragmentShader": "void mainImage(out vec4 fragColor, in vec2 fragCoord) {\n vec2 uv = fragCoord / iResolution.xy;\n fragColor = vec4(uv, 0.5 + 0.5*sin(iTime), 1.0);\n}"
55+
"fragmentShader": "void mainImage(out vec4 fragColor, in vec2 fragCoord) {
56+
vec2 uv = fragCoord / iResolution.xy;
57+
fragColor = vec4(uv, 0.5 + 0.5*sin(iTime), 1.0);
58+
}"
5459
}
5560
```
5661

@@ -79,7 +84,22 @@ _Tool input:_
7984

8085
```json
8186
{
82-
"fragmentShader": "void mainImage(out vec4 fragColor, in vec2 fragCoord) {\n vec2 uv = (fragCoord - 0.5 * iResolution.xy) / iResolution.y;\n float segments = 6.0;\n float zoom = 1.0 + 0.3 * sin(iTime * 0.2);\n float angle = atan(uv.y, uv.x) + iTime * 0.3;\n float r = length(uv) * zoom;\n angle = mod(angle, 6.28 / segments);\n angle = abs(angle - 3.14 / segments);\n vec2 p = vec2(cos(angle), sin(angle)) * r;\n p += iTime * 0.1;\n float v = sin(p.x * 10.0) * sin(p.y * 10.0);\n v += sin(length(p) * 15.0 - iTime * 2.0);\n v += sin(p.x * 5.0 + p.y * 7.0 + iTime);\n vec3 col = 0.5 + 0.5 * cos(v * 2.0 + vec3(0.0, 2.0, 4.0) + iTime);\n fragColor = vec4(col, 1.0);\n}"
87+
"fragmentShader": "void mainImage(out vec4 fragColor, in vec2 fragCoord) {
88+
vec2 uv = (fragCoord - 0.5 * iResolution.xy) / iResolution.y;
89+
float segments = 6.0;
90+
float zoom = 1.0 + 0.3 * sin(iTime * 0.2);
91+
float angle = atan(uv.y, uv.x) + iTime * 0.3;
92+
float r = length(uv) * zoom;
93+
angle = mod(angle, 6.28 / segments);
94+
angle = abs(angle - 3.14 / segments);
95+
vec2 p = vec2(cos(angle), sin(angle)) * r;
96+
p += iTime * 0.1;
97+
float v = sin(p.x * 10.0) * sin(p.y * 10.0);
98+
v += sin(length(p) * 15.0 - iTime * 2.0);
99+
v += sin(p.x * 5.0 + p.y * 7.0 + iTime);
100+
vec3 col = 0.5 + 0.5 * cos(v * 2.0 + vec3(0.0, 2.0, 4.0) + iTime);
101+
fragColor = vec4(col, 1.0);
102+
}"
83103
}
84104
```
85105

@@ -108,7 +128,22 @@ _Tool input:_
108128

109129
```json
110130
{
111-
"fragmentShader": "void mainImage(out vec4 fragColor, in vec2 fragCoord) {\n vec2 uv = (fragCoord - 0.5 * iResolution.xy) / iResolution.y * 2.5;\n vec2 mouse = (iMouse.xy / iResolution.xy - 0.5) * 2.0;\n vec2 c = mouse;\n vec2 z = uv;\n float iter = 0.0;\n for (int i = 0; i < 100; i++) {\n z = vec2(z.x * z.x - z.y * z.y, 2.0 * z.x * z.y) + c;\n if (dot(z, z) > 4.0) break;\n iter++;\n }\n float t = iter / 100.0;\n vec3 col = 0.5 + 0.5 * cos(3.0 + t * 6.28 * 2.0 + vec3(0.0, 0.6, 1.0));\n if (iter == 100.0) col = vec3(0.0);\n fragColor = vec4(col, 1.0);\n}"
131+
"fragmentShader": "void mainImage(out vec4 fragColor, in vec2 fragCoord) {
132+
vec2 uv = (fragCoord - 0.5 * iResolution.xy) / iResolution.y * 2.5;
133+
vec2 mouse = (iMouse.xy / iResolution.xy - 0.5) * 2.0;
134+
vec2 c = mouse;
135+
vec2 z = uv;
136+
float iter = 0.0;
137+
for (int i = 0; i < 100; i++) {
138+
z = vec2(z.x * z.x - z.y * z.y, 2.0 * z.x * z.y) + c;
139+
if (dot(z, z) > 4.0) break;
140+
iter++;
141+
}
142+
float t = iter / 100.0;
143+
vec3 col = 0.5 + 0.5 * cos(3.0 + t * 6.28 * 2.0 + vec3(0.0, 0.6, 1.0));
144+
if (iter == 100.0) col = vec3(0.0);
145+
fragColor = vec4(col, 1.0);
146+
}"
112147
}
113148
```
114149

examples/sheet-music-server/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example: Sheet Music Server
22

3+
![Screenshot](screenshot.png)
4+
35
A demo MCP App that renders [ABC notation](https://en.wikipedia.org/wiki/ABC_notation) as sheet music with interactive audio playback using the [abcjs](https://www.abcjs.net/) library.
46

57
<table>
@@ -38,7 +40,12 @@ When calling the `play-sheet-music` tool, provide ABC notation:
3840

3941
```json
4042
{
41-
"abcNotation": "X:1\nT:C Major Scale\nM:4/4\nL:1/4\nK:C\nC D E F | G A B c |"
43+
"abcNotation": "X:1
44+
T:C Major Scale
45+
M:4/4
46+
L:1/4
47+
K:C
48+
C D E F | G A B c |"
4249
}
4350
```
4451

examples/system-monitor-server/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example: System Monitor App
22

3+
![Screenshot](screenshot.png)
4+
35
A demo MCP App that displays real-time OS metrics with a stacked area chart for per-core CPU usage and a bar gauge for memory.
46

57
<table>

0 commit comments

Comments
 (0)