create-skybridge 0.0.0-dev.c9794a7 → 0.0.0-dev.c9a9356

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 (77) hide show
  1. package/dist/index.js +318 -212
  2. package/package.json +8 -7
  3. package/templates/blank/.dockerignore +4 -0
  4. package/templates/blank/AGENTS.md +1 -0
  5. package/templates/blank/Dockerfile +53 -0
  6. package/templates/blank/README.md +92 -0
  7. package/{template → templates/blank}/_gitignore +2 -1
  8. package/templates/blank/node_modules/.bin/alpic +21 -0
  9. package/templates/blank/node_modules/.bin/sb +21 -0
  10. package/templates/blank/node_modules/.bin/skybridge +21 -0
  11. package/{template → templates/blank}/node_modules/.bin/tsc +2 -2
  12. package/{template → templates/blank}/node_modules/.bin/tsserver +2 -2
  13. package/templates/blank/node_modules/.bin/vite +21 -0
  14. package/templates/blank/package.json +28 -0
  15. package/templates/blank/src/helpers.ts +4 -0
  16. package/templates/blank/src/server.ts +21 -0
  17. package/templates/blank/src/vite-manifest.d.ts +4 -0
  18. package/templates/blank/tsconfig.json +5 -0
  19. package/templates/blank/vite.config.ts +6 -0
  20. package/templates/demo/.dockerignore +4 -0
  21. package/templates/demo/AGENTS.md +1 -0
  22. package/templates/demo/Dockerfile +53 -0
  23. package/templates/demo/README.md +95 -0
  24. package/templates/demo/_gitignore +6 -0
  25. package/templates/demo/alpic.json +3 -0
  26. package/templates/demo/node_modules/.bin/alpic +21 -0
  27. package/templates/demo/node_modules/.bin/sb +21 -0
  28. package/templates/demo/node_modules/.bin/skybridge +21 -0
  29. package/templates/demo/node_modules/.bin/tsc +21 -0
  30. package/templates/demo/node_modules/.bin/tsserver +21 -0
  31. package/templates/demo/node_modules/.bin/vite +21 -0
  32. package/{template → templates/demo}/package.json +15 -7
  33. package/templates/demo/src/helpers.ts +4 -0
  34. package/templates/demo/src/index.css +59 -0
  35. package/templates/demo/src/server.ts +99 -0
  36. package/templates/demo/src/views/components/doc-link.tsx +22 -0
  37. package/templates/demo/src/views/components/doc.tsx +21 -0
  38. package/templates/demo/src/views/components/nav.tsx +31 -0
  39. package/templates/demo/src/views/components/progress.tsx +35 -0
  40. package/templates/demo/src/views/components/steps/outro.tsx +68 -0
  41. package/templates/demo/src/views/components/steps/state.tsx +47 -0
  42. package/templates/demo/src/views/components/steps/tool-call.tsx +53 -0
  43. package/templates/demo/src/views/components/steps/tool-output.tsx +40 -0
  44. package/templates/demo/src/views/images/mascot/beret.png +0 -0
  45. package/templates/demo/src/views/images/mascot/chapka.png +0 -0
  46. package/templates/demo/src/views/images/mascot/cowboy-hat.png +0 -0
  47. package/templates/demo/src/views/images/mascot/fez.png +0 -0
  48. package/templates/demo/src/views/images/mascot/jester-hat.png +0 -0
  49. package/templates/demo/src/views/images/mascot/mitre.png +0 -0
  50. package/templates/demo/src/views/images/mascot/non-la.png +0 -0
  51. package/templates/demo/src/views/images/mascot/original.png +0 -0
  52. package/templates/demo/src/views/images/mascot/propeller-beanie.png +0 -0
  53. package/templates/demo/src/views/images/mascot/ski-mask.png +0 -0
  54. package/templates/demo/src/views/images/mascot/sombrero.png +0 -0
  55. package/templates/demo/src/views/images/mascot/top-hat.png +0 -0
  56. package/templates/demo/src/views/images/mascot/viking-helmet.png +0 -0
  57. package/templates/demo/src/views/onboarding.tsx +63 -0
  58. package/templates/demo/src/views/use-mascot.ts +60 -0
  59. package/templates/demo/src/vite-manifest.d.ts +4 -0
  60. package/templates/demo/tsconfig.json +11 -0
  61. package/templates/demo/vite.config.ts +14 -0
  62. package/dist/index.test.d.ts +0 -1
  63. package/dist/index.test.js +0 -33
  64. package/template/AGENTS.md +0 -1
  65. package/template/README.md +0 -97
  66. package/template/node_modules/.bin/alpic +0 -21
  67. package/template/node_modules/.bin/sb +0 -21
  68. package/template/node_modules/.bin/skybridge +0 -21
  69. package/template/node_modules/.bin/vite +0 -21
  70. package/template/server/src/index.ts +0 -62
  71. package/template/tsconfig.json +0 -9
  72. package/template/web/src/helpers.ts +0 -4
  73. package/template/web/src/index.css +0 -154
  74. package/template/web/src/widgets/magic-8-ball.tsx +0 -27
  75. package/template/web/vite.config.ts +0 -15
  76. /package/{template → templates/blank}/alpic.json +0 -0
  77. /package/{template → templates/demo}/node_modules/.bin/tsx +0 -0
@@ -0,0 +1,53 @@
1
+ # syntax=docker/dockerfile:1
2
+
3
+ # Dockerfile for a Skybridge MCP server.
4
+ #
5
+ # Detects npm, yarn, or pnpm from the lockfile in your project.
6
+ # (For bun or deno, adapt the install/build/prune commands below.)
7
+
8
+ # Build stage: install deps, compile the app, then prune dev deps.
9
+ FROM node:24-slim AS build
10
+ WORKDIR /app
11
+
12
+ COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* .npmrc* ./
13
+ RUN --mount=type=cache,target=/root/.npm \
14
+ --mount=type=cache,target=/usr/local/share/.cache/yarn \
15
+ --mount=type=cache,target=/root/.local/share/pnpm/store \
16
+ if [ -f package-lock.json ]; then \
17
+ npm ci; \
18
+ elif [ -f yarn.lock ]; then \
19
+ corepack enable yarn && yarn install --frozen-lockfile; \
20
+ elif [ -f pnpm-lock.yaml ]; then \
21
+ corepack enable pnpm && pnpm install --frozen-lockfile; \
22
+ else \
23
+ echo "No lockfile found." && exit 1; \
24
+ fi
25
+
26
+ ENV NODE_ENV=production
27
+
28
+ COPY . .
29
+ RUN if [ -f package-lock.json ]; then \
30
+ npm run build && npm prune --omit=dev; \
31
+ elif [ -f yarn.lock ]; then \
32
+ corepack enable yarn && yarn build && yarn install --frozen-lockfile --production=true; \
33
+ elif [ -f pnpm-lock.yaml ]; then \
34
+ corepack enable pnpm && pnpm build && pnpm prune --prod; \
35
+ fi
36
+
37
+ # Runtime stage: copy built artifacts and prod deps, run as non-root.
38
+ FROM node:24-slim AS runtime
39
+ WORKDIR /app
40
+ ENV NODE_ENV=production
41
+
42
+ USER node
43
+
44
+ COPY --from=build --chown=node:node /app/node_modules ./node_modules
45
+ COPY --from=build --chown=node:node /app/dist ./dist
46
+ COPY --from=build --chown=node:node /app/package.json ./package.json
47
+
48
+ EXPOSE 3000
49
+
50
+ # Run the built server directly rather than via `npm start` / `skybridge start`.
51
+ # Each wrapper adds a process layer that can swallow SIGTERM, which makes
52
+ # graceful shutdowns time out on platforms like Cloud Run, Fly, and k8s.
53
+ CMD ["node", "dist/server.js"]
@@ -0,0 +1,92 @@
1
+ # Skybridge Boilerplate
2
+
3
+ A minimal TypeScript boilerplate for building MCP and ChatGPT Apps with the [Skybridge](https://docs.skybridge.tech) framework.
4
+
5
+ ## Getting Started
6
+
7
+ ### Prerequisites
8
+
9
+ - Node.js 24+
10
+
11
+ ### Local Development
12
+
13
+ #### 1. Install
14
+
15
+ ```bash
16
+ npm install
17
+ # or
18
+ pnpm install
19
+ # or
20
+ bun install
21
+ # or
22
+ deno install
23
+ # or
24
+ yarn install
25
+ ```
26
+
27
+ #### 2. Start your local server
28
+
29
+ Run the development server from the root directory:
30
+
31
+ ```bash
32
+ npm run dev
33
+ # or
34
+ pnpm dev
35
+ # or
36
+ bun dev
37
+ # or
38
+ deno task dev
39
+ # or
40
+ yarn dev
41
+ ```
42
+
43
+ This command starts:
44
+ - Your MCP server at `http://localhost:3000/mcp`.
45
+ - Skybridge DevTools UI at `http://localhost:3000`.
46
+
47
+ #### 3. Project structure
48
+
49
+ ```
50
+ ├── src/
51
+ │ ├── server.ts # Server entry point
52
+ │ └── helpers.ts # Shared utilities
53
+ ├── vite.config.ts
54
+ ├── alpic.json # Deployment config
55
+ └── package.json
56
+ ```
57
+
58
+ ### Create your first view
59
+
60
+ #### 1. Add a new view
61
+
62
+ - Register a tool in `src/server.ts` with a unique name (e.g., `my-view`) using [`registerTool`](https://docs.skybridge.tech/api-reference/register-tool) and a `view` config.
63
+ - Create a matching React component at `src/views/my-view.tsx`. **The file name must match the view name exactly**.
64
+
65
+ #### 2. Edit views with Hot Module Replacement (HMR)
66
+
67
+ Edit and save components in `src/views/` — changes will appear instantly inside your App.
68
+
69
+ #### 3. Edit server code
70
+
71
+ Modify files in `src/` and refresh the tool list with your MCP Client to see the changes.
72
+
73
+ ### Testing your App
74
+
75
+ You can test your app locally by using our DevTools UI on `http://localhost:3000` while running the `dev` command.
76
+
77
+ To connect your app with web clients like ChatGPT or Claude, expose your server on the internet by adding the `--tunnel` flag.
78
+ By enabling the tunnel, you'll also be able to access a playground to chat with your app and a real LLM. Learn more by reading the [test guide](https://docs.skybridge.tech/quickstart/test-your-app).
79
+
80
+
81
+ ## Deploy to Production
82
+
83
+ Skybridge is infrastructure vendor agnostic, and your app can be deployed on any cloud platform supporting MCP.
84
+
85
+ The simplest way to deploy your app is by running the `deploy` command, which will push your MCP server to the [Alpic](https://alpic.ai/) cloud for free.
86
+
87
+ ## Resources
88
+ - [Skybridge Documentation](https://docs.skybridge.tech/)
89
+ - [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
90
+ - [MCP Apps Documentation](https://github.com/modelcontextprotocol/ext-apps/tree/main)
91
+ - [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
92
+ - [Alpic Documentation](https://docs.alpic.ai/)
@@ -2,4 +2,5 @@ node_modules/
2
2
  dist/
3
3
  .env*
4
4
  .DS_store
5
- *.tsbuildinfo
5
+ *.tsbuildinfo
6
+ .skybridge/
@@ -0,0 +1,21 @@
1
+ #!/bin/sh
2
+ basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
3
+
4
+ case `uname` in
5
+ *CYGWIN*|*MINGW*|*MSYS*)
6
+ if command -v cygpath > /dev/null 2>&1; then
7
+ basedir=`cygpath -w "$basedir"`
8
+ fi
9
+ ;;
10
+ esac
11
+
12
+ if [ -z "$NODE_PATH" ]; then
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.104.1_@opentelemetry+api@1.9.0_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.104.1_@opentelemetry+api@1.9.0_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
+ else
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.104.1_@opentelemetry+api@1.9.0_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.104.1_@opentelemetry+api@1.9.0_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
+ fi
17
+ if [ -x "$basedir/node" ]; then
18
+ exec "$basedir/node" "$basedir/../alpic/bin/run.js" "$@"
19
+ else
20
+ exec node "$basedir/../alpic/bin/run.js" "$@"
21
+ fi
@@ -0,0 +1,21 @@
1
+ #!/bin/sh
2
+ basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
3
+
4
+ case `uname` in
5
+ *CYGWIN*|*MINGW*|*MSYS*)
6
+ if command -v cygpath > /dev/null 2>&1; then
7
+ basedir=`cygpath -w "$basedir"`
8
+ fi
9
+ ;;
10
+ esac
11
+
12
+ if [ -z "$NODE_PATH" ]; then
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
+ else
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
+ fi
17
+ if [ -x "$basedir/node" ]; then
18
+ exec "$basedir/node" "$basedir/../skybridge/bin/run.js" "$@"
19
+ else
20
+ exec node "$basedir/../skybridge/bin/run.js" "$@"
21
+ fi
@@ -0,0 +1,21 @@
1
+ #!/bin/sh
2
+ basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
3
+
4
+ case `uname` in
5
+ *CYGWIN*|*MINGW*|*MSYS*)
6
+ if command -v cygpath > /dev/null 2>&1; then
7
+ basedir=`cygpath -w "$basedir"`
8
+ fi
9
+ ;;
10
+ esac
11
+
12
+ if [ -z "$NODE_PATH" ]; then
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
+ else
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
+ fi
17
+ if [ -x "$basedir/node" ]; then
18
+ exec "$basedir/node" "$basedir/../skybridge/bin/run.js" "$@"
19
+ else
20
+ exec node "$basedir/../skybridge/bin/run.js" "$@"
21
+ fi
@@ -10,9 +10,9 @@ case `uname` in
10
10
  esac
11
11
 
12
12
  if [ -z "$NODE_PATH" ]; then
13
- export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
14
  else
15
- export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
16
  fi
17
17
  if [ -x "$basedir/node" ]; then
18
18
  exec "$basedir/node" "$basedir/../typescript/bin/tsc" "$@"
@@ -10,9 +10,9 @@ case `uname` in
10
10
  esac
11
11
 
12
12
  if [ -z "$NODE_PATH" ]; then
13
- export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
14
  else
15
- export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
16
  fi
17
17
  if [ -x "$basedir/node" ]; then
18
18
  exec "$basedir/node" "$basedir/../typescript/bin/tsserver" "$@"
@@ -0,0 +1,21 @@
1
+ #!/bin/sh
2
+ basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
3
+
4
+ case `uname` in
5
+ *CYGWIN*|*MINGW*|*MSYS*)
6
+ if command -v cygpath > /dev/null 2>&1; then
7
+ basedir=`cygpath -w "$basedir"`
8
+ fi
9
+ ;;
10
+ esac
11
+
12
+ if [ -z "$NODE_PATH" ]; then
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/vite@8.0.3_@types+node@24.12.0_esbuild@0.27.2_jiti@2.6.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/node_modules/vite/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/vite@8.0.3_@types+node@24.12.0_esbuild@0.27.2_jiti@2.6.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
+ else
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/vite@8.0.3_@types+node@24.12.0_esbuild@0.27.2_jiti@2.6.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/node_modules/vite/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/vite@8.0.3_@types+node@24.12.0_esbuild@0.27.2_jiti@2.6.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
+ fi
17
+ if [ -x "$basedir/node" ]; then
18
+ exec "$basedir/node" "$basedir/../vite/bin/vite.js" "$@"
19
+ else
20
+ exec node "$basedir/../vite/bin/vite.js" "$@"
21
+ fi
@@ -0,0 +1,28 @@
1
+ {
2
+ "name": "skybridge-blank",
3
+ "version": "0.0.1",
4
+ "private": true,
5
+ "description": "Blank Skybridge MCP server template",
6
+ "type": "module",
7
+ "scripts": {
8
+ "dev": "skybridge dev",
9
+ "dev:tunnel": "skybridge dev --tunnel",
10
+ "build": "skybridge build",
11
+ "start": "skybridge start",
12
+ "deploy": "alpic deploy"
13
+ },
14
+ "dependencies": {
15
+ "@modelcontextprotocol/sdk": "^1.29.0",
16
+ "skybridge": "^0.0.0-dev.c9a9356",
17
+ "vite": "^8.0.3"
18
+ },
19
+ "devDependencies": {
20
+ "@skybridge/devtools": "^1.0.0",
21
+ "@types/node": "^24.12.0",
22
+ "alpic": "^1.104.1",
23
+ "typescript": "^6.0.2"
24
+ },
25
+ "engines": {
26
+ "node": ">=24.14.1"
27
+ }
28
+ }
@@ -0,0 +1,4 @@
1
+ import { generateHelpers } from "skybridge/web";
2
+ import type { AppType } from "./server.js";
3
+
4
+ export const { useToolInfo, useCallTool } = generateHelpers<AppType>();
@@ -0,0 +1,21 @@
1
+ import { McpServer } from "skybridge/server";
2
+
3
+ const server = new McpServer(
4
+ {
5
+ name: "skybridge-blank",
6
+ version: "0.0.1",
7
+ },
8
+ { capabilities: {} },
9
+ );
10
+
11
+ // Register tools with `server.registerTool(...)`.
12
+ // Docs: https://docs.skybridge.tech/api-reference/register-tool
13
+
14
+ if (process.env.NODE_ENV === "production") {
15
+ const { default: manifest } = await import("./vite-manifest.js");
16
+ server.setViteManifest(manifest);
17
+ }
18
+
19
+ export default await server.run();
20
+
21
+ export type AppType = typeof server;
@@ -0,0 +1,4 @@
1
+ // Typed shim for the Vite manifest emitted by `skybridge build`. The actual
2
+ // `vite-manifest.js` is generated alongside this file and gitignored.
3
+ declare const manifest: Record<string, { file: string }>;
4
+ export default manifest;
@@ -0,0 +1,5 @@
1
+ {
2
+ "extends": "skybridge/tsconfig",
3
+
4
+ "include": ["src", ".skybridge/**/*.d.ts"]
5
+ }
@@ -0,0 +1,6 @@
1
+ import { skybridge } from "skybridge/vite";
2
+ import { defineConfig } from "vite";
3
+
4
+ export default defineConfig({
5
+ plugins: [skybridge()],
6
+ });
@@ -0,0 +1,4 @@
1
+ node_modules
2
+ .git
3
+ dist
4
+ .env*
@@ -0,0 +1 @@
1
+ This is a ChatGPT/MCP app built with Skybridge. ALWAYS use the `chatgpt-app-builder` skill when planning or updating the codebase.
@@ -0,0 +1,53 @@
1
+ # syntax=docker/dockerfile:1
2
+
3
+ # Dockerfile for a Skybridge MCP server.
4
+ #
5
+ # Detects npm, yarn, or pnpm from the lockfile in your project.
6
+ # (For bun or deno, adapt the install/build/prune commands below.)
7
+
8
+ # Build stage: install deps, compile the app, then prune dev deps.
9
+ FROM node:24-slim AS build
10
+ WORKDIR /app
11
+
12
+ COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* .npmrc* ./
13
+ RUN --mount=type=cache,target=/root/.npm \
14
+ --mount=type=cache,target=/usr/local/share/.cache/yarn \
15
+ --mount=type=cache,target=/root/.local/share/pnpm/store \
16
+ if [ -f package-lock.json ]; then \
17
+ npm ci; \
18
+ elif [ -f yarn.lock ]; then \
19
+ corepack enable yarn && yarn install --frozen-lockfile; \
20
+ elif [ -f pnpm-lock.yaml ]; then \
21
+ corepack enable pnpm && pnpm install --frozen-lockfile; \
22
+ else \
23
+ echo "No lockfile found." && exit 1; \
24
+ fi
25
+
26
+ ENV NODE_ENV=production
27
+
28
+ COPY . .
29
+ RUN if [ -f package-lock.json ]; then \
30
+ npm run build && npm prune --omit=dev; \
31
+ elif [ -f yarn.lock ]; then \
32
+ corepack enable yarn && yarn build && yarn install --frozen-lockfile --production=true; \
33
+ elif [ -f pnpm-lock.yaml ]; then \
34
+ corepack enable pnpm && pnpm build && pnpm prune --prod; \
35
+ fi
36
+
37
+ # Runtime stage: copy built artifacts and prod deps, run as non-root.
38
+ FROM node:24-slim AS runtime
39
+ WORKDIR /app
40
+ ENV NODE_ENV=production
41
+
42
+ USER node
43
+
44
+ COPY --from=build --chown=node:node /app/node_modules ./node_modules
45
+ COPY --from=build --chown=node:node /app/dist ./dist
46
+ COPY --from=build --chown=node:node /app/package.json ./package.json
47
+
48
+ EXPOSE 3000
49
+
50
+ # Run the built server directly rather than via `npm start` / `skybridge start`.
51
+ # Each wrapper adds a process layer that can swallow SIGTERM, which makes
52
+ # graceful shutdowns time out on platforms like Cloud Run, Fly, and k8s.
53
+ CMD ["node", "dist/server.js"]
@@ -0,0 +1,95 @@
1
+ # Skybridge Template
2
+
3
+ A starter TypeScript template for building MCP and ChatGPT Apps with the [Skybridge](https://docs.skybridge.tech) framework.
4
+
5
+ ## Getting Started
6
+
7
+ ### Prerequisites
8
+
9
+ - Node.js 24+
10
+
11
+ ### Local Development
12
+
13
+ #### 1. Install
14
+
15
+ ```bash
16
+ npm install
17
+ # or
18
+ pnpm install
19
+ # or
20
+ bun install
21
+ # or
22
+ deno install
23
+ # or
24
+ yarn install
25
+ ```
26
+
27
+ #### 2. Start your local server
28
+
29
+ Run the development server from the root directory:
30
+
31
+ ```bash
32
+ npm run dev
33
+ # or
34
+ pnpm dev
35
+ # or
36
+ bun dev
37
+ # or
38
+ deno task dev
39
+ # or
40
+ yarn dev
41
+ ```
42
+
43
+ This command starts:
44
+ - Your MCP server at `http://localhost:3000/mcp`.
45
+ - Skybridge DevTools UI at `http://localhost:3000`.
46
+
47
+ #### 3. Project structure
48
+
49
+ ```
50
+ ├── src/
51
+ │ ├── server.ts # Server entry point
52
+ │ ├── views/ # React components (one per view)
53
+ │ ├── components/ # Shared UI components
54
+ │ ├── helpers.ts # Shared utilities
55
+ │ └── index.css # Global styles
56
+ ├── vite.config.ts
57
+ ├── alpic.json # Deployment config
58
+ └── package.json
59
+ ```
60
+
61
+ ### Create your first view
62
+
63
+ #### 1. Add a new view
64
+
65
+ - Register a tool in `src/server.ts` with a unique name (e.g., `my-view`) using [`registerTool`](https://docs.skybridge.tech/api-reference/register-tool) and a `view` config.
66
+ - Create a matching React component at `src/views/my-view.tsx`. **The file name must match the view name exactly**.
67
+
68
+ #### 2. Edit views with Hot Module Replacement (HMR)
69
+
70
+ Edit and save components in `src/views/` — changes will appear instantly inside your App.
71
+
72
+ #### 3. Edit server code
73
+
74
+ Modify files in `src/` and refresh the tool list with your MCP Client to see the changes.
75
+
76
+ ### Testing your App
77
+
78
+ You can test your app locally by using our DevTools UI on `http://localhost:3000` while running the `dev` command.
79
+
80
+ To connect your app with web clients like ChatGPT or Claude, expose your server on the internet by adding the `--tunnel` flag.
81
+ By enabling the tunnel, you'll also be able to access a playground to chat with your app and a real LLM. Learn more by reading the [test guide](https://docs.skybridge.tech/quickstart/test-your-app).
82
+
83
+
84
+ ## Deploy to Production
85
+
86
+ Skybridge is infrastructure vendor agnostic, and your app can be deployed on any cloud platform supporting MCP.
87
+
88
+ The simplest way to deploy your app is by running the `deploy` command, which will push your MCP server to the [Alpic](https://alpic.ai/) cloud for free.
89
+
90
+ ## Resources
91
+ - [Skybridge Documentation](https://docs.skybridge.tech/)
92
+ - [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
93
+ - [MCP Apps Documentation](https://github.com/modelcontextprotocol/ext-apps/tree/main)
94
+ - [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
95
+ - [Alpic Documentation](https://docs.alpic.ai/)
@@ -0,0 +1,6 @@
1
+ node_modules/
2
+ dist/
3
+ .env*
4
+ .DS_store
5
+ *.tsbuildinfo
6
+ .skybridge/
@@ -0,0 +1,3 @@
1
+ {
2
+ "$schema": "https://assets.alpic.ai/alpic.json"
3
+ }
@@ -0,0 +1,21 @@
1
+ #!/bin/sh
2
+ basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
3
+
4
+ case `uname` in
5
+ *CYGWIN*|*MINGW*|*MSYS*)
6
+ if command -v cygpath > /dev/null 2>&1; then
7
+ basedir=`cygpath -w "$basedir"`
8
+ fi
9
+ ;;
10
+ esac
11
+
12
+ if [ -z "$NODE_PATH" ]; then
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.104.1_@opentelemetry+api@1.9.0_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.104.1_@opentelemetry+api@1.9.0_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
+ else
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.104.1_@opentelemetry+api@1.9.0_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.104.1_@opentelemetry+api@1.9.0_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
+ fi
17
+ if [ -x "$basedir/node" ]; then
18
+ exec "$basedir/node" "$basedir/../alpic/bin/run.js" "$@"
19
+ else
20
+ exec node "$basedir/../alpic/bin/run.js" "$@"
21
+ fi
@@ -0,0 +1,21 @@
1
+ #!/bin/sh
2
+ basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
3
+
4
+ case `uname` in
5
+ *CYGWIN*|*MINGW*|*MSYS*)
6
+ if command -v cygpath > /dev/null 2>&1; then
7
+ basedir=`cygpath -w "$basedir"`
8
+ fi
9
+ ;;
10
+ esac
11
+
12
+ if [ -z "$NODE_PATH" ]; then
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
+ else
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
+ fi
17
+ if [ -x "$basedir/node" ]; then
18
+ exec "$basedir/node" "$basedir/../skybridge/bin/run.js" "$@"
19
+ else
20
+ exec node "$basedir/../skybridge/bin/run.js" "$@"
21
+ fi
@@ -0,0 +1,21 @@
1
+ #!/bin/sh
2
+ basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
3
+
4
+ case `uname` in
5
+ *CYGWIN*|*MINGW*|*MSYS*)
6
+ if command -v cygpath > /dev/null 2>&1; then
7
+ basedir=`cygpath -w "$basedir"`
8
+ fi
9
+ ;;
10
+ esac
11
+
12
+ if [ -z "$NODE_PATH" ]; then
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
+ else
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
+ fi
17
+ if [ -x "$basedir/node" ]; then
18
+ exec "$basedir/node" "$basedir/../skybridge/bin/run.js" "$@"
19
+ else
20
+ exec node "$basedir/../skybridge/bin/run.js" "$@"
21
+ fi
@@ -0,0 +1,21 @@
1
+ #!/bin/sh
2
+ basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
3
+
4
+ case `uname` in
5
+ *CYGWIN*|*MINGW*|*MSYS*)
6
+ if command -v cygpath > /dev/null 2>&1; then
7
+ basedir=`cygpath -w "$basedir"`
8
+ fi
9
+ ;;
10
+ esac
11
+
12
+ if [ -z "$NODE_PATH" ]; then
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
+ else
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
+ fi
17
+ if [ -x "$basedir/node" ]; then
18
+ exec "$basedir/node" "$basedir/../typescript/bin/tsc" "$@"
19
+ else
20
+ exec node "$basedir/../typescript/bin/tsc" "$@"
21
+ fi
@@ -0,0 +1,21 @@
1
+ #!/bin/sh
2
+ basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
3
+
4
+ case `uname` in
5
+ *CYGWIN*|*MINGW*|*MSYS*)
6
+ if command -v cygpath > /dev/null 2>&1; then
7
+ basedir=`cygpath -w "$basedir"`
8
+ fi
9
+ ;;
10
+ esac
11
+
12
+ if [ -z "$NODE_PATH" ]; then
13
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
14
+ else
15
+ export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
16
+ fi
17
+ if [ -x "$basedir/node" ]; then
18
+ exec "$basedir/node" "$basedir/../typescript/bin/tsserver" "$@"
19
+ else
20
+ exec node "$basedir/../typescript/bin/tsserver" "$@"
21
+ fi