Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,36 @@ jobs:
run: npm publish --workspace examples/${{ matrix.example }} --provenance --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_SECRET }}

publish-packages:
runs-on: ubuntu-latest
if: github.event_name == 'release'
environment: Release
needs: [publish]

permissions:
contents: read
id-token: write

strategy:
fail-fast: false
matrix:
package:
- create-mcp-app

steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: "22"
cache: npm
registry-url: "https://registry.npmjs.org"
- run: npm ci

- name: Build package
run: npm run build --workspace packages/${{ matrix.package }}

- name: Publish package
run: npm publish --workspace packages/${{ matrix.package }} --provenance --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_SECRET }}
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,18 @@ There's no _supported_ host implementation in this repo (beyond the [examples/ba

The [MCP-UI](https://github.com/idosal/mcp-ui) client SDK offers a fully-featured MCP Apps framework used by a few hosts. Clients may choose to use it or roll their own implementation.

## Quick Start

Create a new MCP App project in seconds:

```bash
npm create @modelcontextprotocol/mcp-app my-app
cd my-app
npm run dev
```

Choose from React or Vanilla JS templates. See the [create-mcp-app README](packages/create-mcp-app/README.md) for all options.

## Installation

```bash
Expand Down
80 changes: 78 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
"dist"
],
"workspaces": [
"examples/*"
"examples/*",
"packages/*"
],
"scripts": {
"postinstall": "node scripts/setup-bun.mjs || echo 'setup-bun.mjs failed or not available'",
Expand Down
44 changes: 44 additions & 0 deletions packages/create-mcp-app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# @modelcontextprotocol/create-mcp-app

Scaffold new MCP App projects with one command.

## Usage

```bash
# Interactive mode
npm create @modelcontextprotocol/mcp-app

# With project name
npm create @modelcontextprotocol/mcp-app my-app

# With framework
npm create @modelcontextprotocol/mcp-app my-app --framework react
```

## Frameworks

- **react** - React + Vite + TypeScript
- **vanillajs** - Vanilla JavaScript + Vite + TypeScript

## What's Included

Each generated project includes:

- MCP server with a sample tool
- Interactive UI that communicates with the host
- Vite build configuration for bundling the UI
- TypeScript configuration
- Development server with hot reload

## Getting Started

After creating your project:

```bash
cd my-app
npm run dev
```

## License

MIT
Loading
Loading