Installation

PancakeJS is modular — install only what you need.

Package Manager

# Core packages
pnpm add @pancakeapps/core @pancakeapps/server @pancakeapps/react

# Adapters (install the ones you need)
pnpm add @pancakeapps/adapter-mcp-apps
pnpm add @pancakeapps/adapter-chatgpt-apps

# CLI for development
pnpm add @pancakeapps/cli

# Required peer dependencies
pnpm add zod react react-dom

# Core packages
npm install @pancakeapps/core @pancakeapps/server @pancakeapps/react

# Adapters (install the ones you need)
npm install @pancakeapps/adapter-mcp-apps
npm install @pancakeapps/adapter-chatgpt-apps

# CLI for development
npm install @pancakeapps/cli

# Required peer dependencies
npm install zod react react-dom

# Core packages
yarn add @pancakeapps/core @pancakeapps/server @pancakeapps/react

# Adapters (install the ones you need)
yarn add @pancakeapps/adapter-mcp-apps
yarn add @pancakeapps/adapter-chatgpt-apps

# CLI for development
yarn add @pancakeapps/cli

# Required peer dependencies
yarn add zod react react-dom

Quick Install (All Packages)

For most projects, install everything at once:

pnpm add @pancakeapps/core @pancakeapps/server @pancakeapps/react \
  @pancakeapps/adapter-mcp-apps @pancakeapps/adapter-chatgpt-apps \
  @pancakeapps/cli zod react react-dom

TypeScript Configuration

Add TypeScript types:

pnpm add -D typescript @types/react @types/react-dom

Create or update your tsconfig.json:

{
  "compilerOptions": {
    "target": "ES2022",
    "lib": ["ES2022", "DOM", "DOM.Iterable"],
    "module": "ESNext",
    "moduleResolution": "bundler",
    "jsx": "react-jsx",
    "strict": true,
    "skipLibCheck": true,
    "esModuleInterop": true,
    "resolveJsonModule": true,
    "declaration": true,
    "outDir": "dist"
  },
  "include": ["src/**/*", "server.ts"],
  "exclude": ["node_modules", "dist"]
}

Package Overview

Package	Description
`@pancakeapps/core`	Platform-agnostic types, registry, validation, and adapter interfaces
`@pancakeapps/server`	Server runtime with adapter management and resource store
`@pancakeapps/react`	React hooks (`useToolInvocation`, `useWidgetState`, `useCallTool`, etc.)
`@pancakeapps/adapter-mcp-apps`	Adapter for MCP-compatible hosts (Claude Desktop, etc.)
`@pancakeapps/adapter-chatgpt-apps`	Adapter for ChatGPT Apps
`@pancakeapps/cli`	CLI for development (`dev`), building (`build`), and running (`start`)

Verifying Installation

Create a simple test file to verify everything is working:

// test.ts
import { createUniversalServerApp } from '@pancakeapps/server';
import { z } from 'zod';

const app = createUniversalServerApp({
  name: 'test-app',
  version: '1.0.0',
});

console.log('✅ PancakeJS installed successfully!');

Run it:

npx tsx test.ts

You should see "✅ PancakeJS installed successfully!" in your terminal.

Next Steps

Quick Start — Create your first tool
Getting Started — Full walkthrough