Skip to content

Commit 60bb8d6

Browse files
committed
docs: add MCP client configuration to example READMEs
Add stdio transport configuration snippets near the top of each example README to help users quickly set up the servers in their MCP clients. - Node.js examples use npx with the published npm packages - Python qr-server uses uv with local path - Removed Claude Desktop-specific references from qr-server
1 parent 8c3b1da commit 60bb8d6

20 files changed

Lines changed: 303 additions & 14 deletions

File tree

examples/basic-server-preact/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ An MCP App example with a Preact UI.
55
> [!TIP]
66
> Looking for a vanilla JavaScript example? See [`basic-server-vanillajs`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-vanillajs)!
77
8+
## MCP Client Configuration
9+
10+
Add to your MCP client configuration (stdio transport):
11+
12+
```json
13+
{
14+
"mcpServers": {
15+
"basic-preact": {
16+
"command": "npx",
17+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-basic-preact", "--stdio"]
18+
}
19+
}
20+
}
21+
```
22+
823
## Overview
924

1025
- Tool registration with a linked UI resource

examples/basic-server-react/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,21 @@ An MCP App example with a React UI.
77
> [!TIP]
88
> Looking for a vanilla JavaScript example? See [`basic-server-vanillajs`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-vanillajs)!
99
10+
## MCP Client Configuration
11+
12+
Add to your MCP client configuration (stdio transport):
13+
14+
```json
15+
{
16+
"mcpServers": {
17+
"basic-react": {
18+
"command": "npx",
19+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-basic-react", "--stdio"]
20+
}
21+
}
22+
}
23+
```
24+
1025
## Overview
1126

1227
- Tool registration with a linked UI resource

examples/basic-server-solid/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ An MCP App example with a Solid UI.
55
> [!TIP]
66
> Looking for a vanilla JavaScript example? See [`basic-server-vanillajs`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-vanillajs)!
77
8+
## MCP Client Configuration
9+
10+
Add to your MCP client configuration (stdio transport):
11+
12+
```json
13+
{
14+
"mcpServers": {
15+
"basic-solid": {
16+
"command": "npx",
17+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-basic-solid", "--stdio"]
18+
}
19+
}
20+
}
21+
```
22+
823
## Overview
924

1025
- Tool registration with a linked UI resource

examples/basic-server-svelte/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ An MCP App example with a Svelte 5 UI using runes for reactivity.
55
> [!TIP]
66
> Looking for a vanilla JavaScript example? See [`basic-server-vanillajs`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-vanillajs)!
77
8+
## MCP Client Configuration
9+
10+
Add to your MCP client configuration (stdio transport):
11+
12+
```json
13+
{
14+
"mcpServers": {
15+
"basic-svelte": {
16+
"command": "npx",
17+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-basic-svelte", "--stdio"]
18+
}
19+
}
20+
}
21+
```
22+
823
## Overview
924

1025
- Tool registration with a linked UI resource

examples/basic-server-vanillajs/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ An MCP App example with a vanilla JavaScript UI (no framework).
55
> [!TIP]
66
> Looking for a React-based example? See [`basic-server-react`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-react)!
77
8+
## MCP Client Configuration
9+
10+
Add to your MCP client configuration (stdio transport):
11+
12+
```json
13+
{
14+
"mcpServers": {
15+
"basic-vanillajs": {
16+
"command": "npx",
17+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-basic-vanillajs", "--stdio"]
18+
}
19+
}
20+
}
21+
```
22+
823
## Overview
924

1025
- Tool registration with a linked UI resource

examples/basic-server-vue/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ An MCP App example with a Vue 3 UI using the Composition API.
55
> [!TIP]
66
> Looking for a vanilla JavaScript example? See [`basic-server-vanillajs`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-vanillajs)!
77
8+
## MCP Client Configuration
9+
10+
Add to your MCP client configuration (stdio transport):
11+
12+
```json
13+
{
14+
"mcpServers": {
15+
"basic-vue": {
16+
"command": "npx",
17+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-basic-vue", "--stdio"]
18+
}
19+
}
20+
}
21+
```
22+
823
## Overview
924

1025
- Tool registration with a linked UI resource

examples/budget-allocator-server/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@ An interactive budget allocation tool demonstrating real-time data visualization
1010
</tr>
1111
</table>
1212

13+
## MCP Client Configuration
14+
15+
Add to your MCP client configuration (stdio transport):
16+
17+
```json
18+
{
19+
"mcpServers": {
20+
"budget-allocator": {
21+
"command": "npx",
22+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-budget-allocator", "--stdio"]
23+
}
24+
}
25+
}
26+
```
27+
1328
## Features
1429

1530
- **Interactive Sliders**: Adjust budget allocation across 5 categories (Marketing, Engineering, Operations, Sales, R&D)

examples/cohort-heatmap-server/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@ A demo MCP App that displays cohort retention data as an interactive heatmap, sh
1010
</tr>
1111
</table>
1212

13+
## MCP Client Configuration
14+
15+
Add to your MCP client configuration (stdio transport):
16+
17+
```json
18+
{
19+
"mcpServers": {
20+
"cohort-heatmap": {
21+
"command": "npx",
22+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-cohort-heatmap", "--stdio"]
23+
}
24+
}
25+
}
26+
```
27+
1328
## Features
1429

1530
- **Cohort Retention Heatmap**: Color-coded grid showing retention percentages across cohorts and time periods

examples/customer-segmentation-server/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@ A demo MCP App that displays customer data as an interactive scatter/bubble char
1010
</tr>
1111
</table>
1212

13+
## MCP Client Configuration
14+
15+
Add to your MCP client configuration (stdio transport):
16+
17+
```json
18+
{
19+
"mcpServers": {
20+
"customer-segmentation": {
21+
"command": "npx",
22+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-customer-segmentation", "--stdio"]
23+
}
24+
}
25+
}
26+
```
27+
1328
## Features
1429

1530
- **Interactive Scatter Plot**: Bubble chart visualization using Chart.js with configurable X/Y axes

examples/map-server/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44

55
Interactive 3D globe viewer using CesiumJS with OpenStreetMap tiles. Demonstrates geocoding integration and full MCP App capabilities.
66

7+
## MCP Client Configuration
8+
9+
Add to your MCP client configuration (stdio transport):
10+
11+
```json
12+
{
13+
"mcpServers": {
14+
"map": {
15+
"command": "npx",
16+
"args": ["-y", "--silent", "--registry=https://registry.npmjs.org/", "@modelcontextprotocol/server-map", "--stdio"]
17+
}
18+
}
19+
}
20+
```
21+
722
## Features
823

924
- **3D Globe Rendering**: Interactive CesiumJS globe with rotation, zoom, and 3D perspective

0 commit comments

Comments
 (0)