# Everything Example

A playground MCP app built with [Skybridge](https://docs.skybridge.tech/home) that showcases all Skybridge hooks and features for building ChatGPT and MCP Apps in one place.

## What This Example Showcases

This example demonstrates every major Skybridge capability in a single widget with tabs:

- **useToolInfo** — Tool input, output, and metadata
- **useLayout** — Theme (light/dark) and layout
- **useUser** — User locale and profile
- **useDisplayMode** — Inline vs fullscreen
- **useWidgetState** — Persistent widget state
- **useCallTool** — Calling server tools from the widget
- **useRequestModal** — Modal dialogs
- **useOpenExternal** — Opening external URLs
- **useSendFollowUpMessage** — Sending follow-up messages to the AI
- **useSetOpenInAppUrl** — In-app URL handling
- **useFiles** — File access
- **Images** — Displaying images in widgets (import assets, use `@/` or relative paths)
- **data-llm** — Dynamic LLM context
- **createStore** — Shared state (optional pattern)

## Live Demo

[Try it in Alpic's Playground](https://everything.skybridge.tech/try) to launch the live widget experience, or use the MCP URL with your client of choice: `https://everything.skybridge.tech/mcp`.

## Getting Started

### Prerequisites

- Node.js 24+

### Local Development

#### 1. Install

```bash
npm install
# or
yarn install
# or
pnpm install
# or
bun install
```

#### 2. Start your local server

Run the development server from the root directory:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

This command starts:

- Your MCP server at `http://localhost:3000/mcp`.
- Skybridge DevTools UI at `http://localhost:3000/`.

#### 3. Project structure

```
│   └── server.ts      # Server entry point
│   ├── src/
│   │   ├── views/
│   │   │   ├── show-everything.tsx   # Main widget (tabbed UI)
│   │   │   └── tabs/                # One component per hook/feature
│   │   │       ├── home-tab.tsx
│   │   │       ├── use-layout-tab.tsx
│   │   │       ├── image-tab/       # Images (index.tsx + assets)
│   │   │       │   ├── index.tsx
│   │   │       │   └── skybridge.jpg
│   │   │       └── ...
│   │   ├── helpers.ts    # Shared utilities
│   │   └── index.css     # Global styles
│   └── vite.config.ts
├── alpic.json            # Deployment config
├── nodemon.json          # Dev server config
└── package.json
```

### Create your first widget

#### 1. Add a new widget

- Register a widget in `src/server.ts` with a unique name (e.g., `my-widget`) using [`registerTool`](https://docs.skybridge.tech/api-reference/register-tool)
- Create a matching React component at `src/views/my-widget.tsx`. **The file name must match the widget name exactly**.

#### 2. Edit widgets with Hot Module Replacement (HMR)

Edit and save components in `src/views/` — changes will appear instantly inside your App.

#### 3. Edit server code

Modify files in `server/` and refresh the connection with your testing MCP Client to see the changes.

### Testing your App

You can test your App locally by using our DevTools UI on `http://localhost:3000` while running the dev command.

To test your app with other MCP Clients like ChatGPT, Claude or VSCode, see [Testing Your App](https://docs.skybridge.tech/quickstart/test-your-app).

## Deploy to Production

Skybridge is infrastructure vendor agnostic, and your app can be deployed on any cloud platform supporting MCP.

The simplest way to deploy your App in minutes is [Alpic](https://alpic.ai/).

1. Create an account on [Alpic platform](https://app.alpic.ai/).
2. Connect your GitHub repository to automatically deploy at each commit.
3. Use your remote App URL to connect it to MCP Clients, or use the Alpic Playground to easily test your App.

## Resources

- [Skybridge Documentation](https://docs.skybridge.tech/)
- [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
- [Alpic Documentation](https://docs.alpic.ai/)
