Skip to main content

​
Overview

The sunpeak new command creates a new sunpeak project with a minimal, convention-based structure for building MCP Apps. 
sunpeak new
Install sunpeak globally first:
pnpm add -g sunpeak

​
Usage

Create a new project interactively: 
sunpeak new
Or specify a project name: 
sunpeak new sunpeak-app
Or specify both project name and resources to include: 
sunpeak new sunpeak-app review,carousel

​
Arguments

ArgumentDescription
projectNameName of the project directory (optional, prompts if not provided)
resourcesComma or space-separated list of resources to include (optional, prompts if not provided)

​
What Gets Created

The framework includes:
  • Convention-based structure - Resources auto-discovered from src/resources/{name}/, tools from src/tools/, simulations from tests/simulations/
  • Tool files - Real tool handlers with Zod schemas in src/tools/
  • Pre-configured tooling - Vite, TypeScript, Tailwind CSS 4, Vitest
  • Development scripts - Ready-to-use dev, build, mcp, and test commands
  • Example components - Sample MCP Resources to get started quickly

​
Project Structure

sunpeak-app/
├── src/
│   ├── resources/
│   │   └── review/
│   │       └── review.tsx
│   ├── tools/
│   │   └── review-diff.ts
│   └── server.ts
├── tests/simulations/
│   └── review-diff.json
└── package.json

​
Next Steps

After creating your project:
  1. Navigate to your project: cd sunpeak-app
  2. Start the dev server: sunpeak dev
  3. Open http://localhost:3000 to see the inspector

Project Scaffold

Learn more about the project structure and available commands.