sunpeak 0.16.11 → 0.16.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +12 -11
  2. package/package.json +1 -1
  3. package/template/README.md +3 -2
package/README.md CHANGED
@@ -22,7 +22,7 @@ Quickstart, build, test, and ship your Claude or ChatGPT App!
22
22
 
23
23
  [Demo (Hosted)](https://sunpeak.ai/simulator) ~
24
24
  [Demo (Video)](https://cdn.sunpeak.ai/sunpeak-demo-prod.mp4) ~
25
- [Discord (NEW)](https://discord.gg/FB2QNXqRnw) ~
25
+ [Discord](https://discord.gg/FB2QNXqRnw) ~
26
26
  [Documentation](https://sunpeak.ai/docs) ~
27
27
  [GitHub](https://github.com/Sunpeak-AI/sunpeak)
28
28
 
@@ -45,7 +45,7 @@ sunpeak new
45
45
 
46
46
  ## Overview
47
47
 
48
- `sunpeak` is an npm package that helps you build MCP Apps (interactive UI resources) while keeping your MCP server client-agnostic. Built on the [MCP Apps SDK](https://github.com/modelcontextprotocol/ext-apps) (`@modelcontextprotocol/ext-apps`). `sunpeak` consists of:
48
+ `sunpeak` is an npm package that helps you build MCP Apps (interactive UI [resources](https://sunpeak.ai/docs/mcp-apps/mcp/resources)) while keeping your [MCP server](https://sunpeak.ai/docs/mcp-apps/mcp/overview) client-agnostic. Built on the [MCP Apps SDK](https://github.com/modelcontextprotocol/ext-apps) (`@modelcontextprotocol/ext-apps`). `sunpeak` consists of:
49
49
 
50
50
  ### The `sunpeak` library
51
51
 
@@ -55,21 +55,21 @@ sunpeak new
55
55
 
56
56
  ### The `sunpeak` framework
57
57
 
58
- Next.js for MCP Apps. Using an example App `my-app` with a `Review` UI (MCP resource), `sunpeak` projects look like:
58
+ Next.js for MCP Apps. Using an example App `my-app` with a `Review` UI ([MCP resource](https://sunpeak.ai/docs/mcp-apps/mcp/resources)), `sunpeak` projects look like:
59
59
 
60
60
  ```bash
61
61
  my-app/
62
62
  ├── src/
63
63
  │ ├── resources/
64
64
  │ │ └── review/
65
- │ │ └── review.tsx # Review UI component + resource metadata.
65
+ │ │ └── review.tsx # Review UI component + resource metadata.
66
66
  │ ├── tools/
67
- │ │ ├── review-diff.ts # Tool with handler, schema, and resource reference.
68
- │ │ └── review-post.ts # Multiple tools can share one resource.
69
- │ └── server.ts # Optional: auth, server config.
67
+ │ │ ├── review-diff.ts # Tool with handler, schema, and resource reference.
68
+ │ │ └── review-post.ts # Multiple tools can share one resource.
69
+ │ └── server.ts # Optional: auth, server config.
70
70
  ├── tests/simulations/
71
- │ ├── review-diff.json # Mock state for testing.
72
- │ └── review-post.json # Mock state for testing.
71
+ │ ├── review-diff.json # Mock state for testing.
72
+ │ └── review-post.json # Mock state for testing.
73
73
  └── package.json
74
74
  ```
75
75
 
@@ -92,11 +92,11 @@ Commands for managing MCP Apps:
92
92
 
93
93
  ## Example App
94
94
 
95
- Example `Resource`, `Simulation`, and testing file (using the `Simulator`) for an MCP resource called "Review".
95
+ Example `Resource`, `Simulation`, and testing file (using the `Simulator`) for an [MCP resource](https://sunpeak.ai/docs/mcp-apps/mcp/resources) called "Review".
96
96
 
97
97
  ### `Resource` Component
98
98
 
99
- Each resource `.tsx` file exports both the React component and the MCP resource metadata:
99
+ Each resource `.tsx` file exports both the React component and the [MCP resource](https://sunpeak.ai/docs/mcp-apps/mcp/resources) metadata:
100
100
 
101
101
  ```tsx
102
102
  // src/resources/review/review.tsx
@@ -222,5 +222,6 @@ npx skills add Sunpeak-AI/sunpeak@create-sunpeak-app
222
222
  ## Resources
223
223
 
224
224
  - [MCP Apps Documentation](https://sunpeak.ai/docs/mcp-apps/introduction)
225
+ - [MCP Overview](https://sunpeak.ai/docs/mcp-apps/mcp/overview) · [Tools](https://sunpeak.ai/docs/mcp-apps/mcp/tools) · [Resources](https://sunpeak.ai/docs/mcp-apps/mcp/resources)
225
226
  - [MCP Apps SDK](https://github.com/modelcontextprotocol/ext-apps)
226
227
  - [ChatGPT Apps SDK Design Guidelines](https://developers.openai.com/apps-sdk/concepts/design-guidelines)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sunpeak",
3
- "version": "0.16.11",
3
+ "version": "0.16.12",
4
4
  "description": "Local-first MCP Apps framework. Quickstart, build, test, and ship your Claude or ChatGPT App!",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
package/template/README.md CHANGED
@@ -47,7 +47,7 @@ my-app/
47
47
 
48
48
  ## Testing in ChatGPT
49
49
 
50
- Test your app directly in ChatGPT using the built-in MCP endpoint (starts automatically with `sunpeak dev`):
50
+ Test your app directly in ChatGPT using the built-in [MCP](https://sunpeak.ai/docs/mcp-apps/mcp/overview) endpoint (starts automatically with `sunpeak dev`):
51
51
 
52
52
  ```bash
53
53
  # Start the dev server + MCP endpoint.
@@ -91,7 +91,7 @@ sunpeak start --port 3000 # Custom port (default: 8000)
91
91
 
92
92
  ## Add a new UI (Resource)
93
93
 
94
- To add a new UI (MCP Resource), create a new directory under `src/resources/` with the following files:
94
+ To add a new UI ([MCP Resource](https://sunpeak.ai/docs/mcp-apps/mcp/resources)), create a new directory under `src/resources/` with the following files:
95
95
 
96
96
  ```
97
97
  src/resources/NAME/
@@ -116,5 +116,6 @@ npx skills add Sunpeak-AI/sunpeak@create-sunpeak-app
116
116
 
117
117
  - [sunpeak](https://github.com/Sunpeak-AI/sunpeak)
118
118
  - [MCP Apps Documentation](https://sunpeak.ai/docs/mcp-apps/introduction)
119
+ - [MCP Overview](https://sunpeak.ai/docs/mcp-apps/mcp/overview) · [Tools](https://sunpeak.ai/docs/mcp-apps/mcp/tools) · [Resources](https://sunpeak.ai/docs/mcp-apps/mcp/resources)
119
120
  - [MCP Apps SDK](https://github.com/modelcontextprotocol/ext-apps)
120
121
  - [ChatGPT Apps SDK Design Guidelines](https://developers.openai.com/apps-sdk/concepts/design-guidelines)