Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.agentfront.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

  • Node.js: Version 24+ (LTS)
    • The engines field in @frontmcp/sdk and frontmcp requires Node 24+. FrontMCP is developed and tested on Node 24.
  • npm ≥ 10 (pnpm / yarn work too)
  • TypeScript project (the init command can set this up)

​
Option A — Create a new project

Use the built-in project generator. It will create a new folder under your current directory.
npx frontmcp create my-app
The create command is interactive by default:
? Project name: my-app
? Deployment target:
  > Node.js (Docker)
    Vercel (Serverless)
    AWS Lambda
    Cloudflare Workers
? Redis setup: (Docker target only)
  > Docker Compose
    Existing Redis
    None
? Enable GitHub Actions CI/CD? (Y/n)
Use --yes (or -y) to skip prompts and use defaults.

​
CLI Flags

FlagDescriptionDefault
--yes, -yUse defaults (non-interactive)-
--target <type>Deployment: node, vercel, lambda, cloudflarenode
--redis <setup>Redis: docker, existing, nonedocker
--cicd / --no-cicdEnable GitHub Actions--cicd
--pm <manager>Package manager: npm, yarn, pnpmnpm
Examples:
# Interactive mode (default)
npx frontmcp create my-app

# Non-interactive with defaults
npx frontmcp create my-app --yes

# Vercel target with CI/CD
npx frontmcp create my-app --target vercel

# Use pnpm as package manager
npx frontmcp create my-app --pm pnpm --yes

# Docker without Redis
npx frontmcp create my-app --target node --redis none --no-cicd
This will:
  • scaffold a FrontMCP project in ./my-app
  • configure tsconfig.json for decorators and modern ESM
  • generate a package.json with helpful scripts
  • create deployment configuration for your target (Dockerfile, vercel.json, etc.)
  • generate GitHub Actions workflows (if enabled)
  • install required dev dependencies (e.g. TypeScript, tsx, zod, reflect-metadata)

​
Option B — Add to an existing project

Install the SDK, CLI, and Node types:
npm i @frontmcp/sdk reflect-metadata
npm i -D frontmcp @types/node@^24
Then initialize FrontMCP in your project root:
npx frontmcp init
init will:
  • create or update your tsconfig.json with the required decorator settings (experimentalDecorators, emitDecoratorMetadata, target: es2021, module: esnext)

​
Package scripts

After create, you’ll have these scripts:
{
  "scripts": {
    "dev": "frontmcp dev",
    "build": "frontmcp build",
    "inspect": "frontmcp inspector",
    "doctor": "frontmcp doctor",
    "test": "frontmcp test"
  }
}
What they do
  • frontmcp dev — run your server in watch mode (tsx)
  • frontmcp build — bundle your entry for the configured deployment target (outputs to ./dist by default)
  • frontmcp inspector — launch the MCP Inspector (npx @modelcontextprotocol/inspector)
  • frontmcp doctor — validate Node/npm versions, tsconfig, and project setup
  • frontmcp test — run E2E tests with the auto-injected Jest configuration

​
Verify your setup

Run:
npm run doctor
If anything is missing or misconfigured (Node/npm versions, tsconfig.json, scripts), doctor will tell you exactly what to fix.

​
Next steps

  • Start developing: npm run dev (standard) or nx dev <app> (Nx)
  • Build for distribution: npm run build (standard) or nx build <project> (Nx)
  • Explore tools and messages live: npm run inspect (standard) or nx inspector <app> (Nx)