Workspace Generator

Scaffolds a complete FrontMCP Nx monorepo with pre-configured tooling, dependencies, and directory structure.

Usage

nx g @frontmcp/nx:workspace my-platform

Or via the CLI shortcut:

npx frontmcp create my-platform --nx

Options

Option	Type	Default	Description
`name`	`string`	—	Required. The name of the workspace
`packageManager`	`npm` \| `yarn` \| `pnpm` \| `bun`	`npm`	Package manager to use
`skipInstall`	`boolean`	`false`	Skip package installation
`skipGit`	`boolean`	`false`	Skip git initialization. When `false`, runs `git init` and creates an initial commit.
`createSampleApp`	`boolean`	`true`	Create a sample demo application

Generated Files

my-platform/
├── apps/                    # FrontMCP applications (with sample demo app and its starter spec if enabled)
├── libs/                    # Shared libraries
├── servers/                 # Deployment shells
├── nx.json                  # Nx workspace configuration
├── tsconfig.base.json       # Shared TypeScript config
├── package.json             # Dependencies and scripts
├── README.md
├── AGENTS.md                # AI agent guidance
├── CLAUDE.md                # Claude Code project instructions
├── .cursorrules             # Cursor editor rules
├── .mcp.json
├── .nvmrc
├── .gitignore
└── .prettierrc

Example

nx g @frontmcp/nx:workspace my-platform --packageManager yarn --createSampleApp

The package.json includes all FrontMCP dependencies:

{
  "dependencies": {
    "@frontmcp/sdk": "...",
    "frontmcp": "...",
    "reflect-metadata": "^0.2.2",
    "zod": "^4.0.0"
  },
  "devDependencies": {
    "@frontmcp/nx": "...",
    "@frontmcp/testing": "...",
    "nx": "22.6.4",
    "typescript": "~5.9.2"
  }
}

The nx.json configures the ESLint and Jest plugins, build caching and dependency ordering. Generated projects declare their own targets (build on apps, servers and publishable libraries, test on apps and libraries, typecheck on all of them), and apps reach libraries through the tsconfig.base.json path aliases, so the workspace does not register @nx/js/typescript: its inferred tsc --build targets need a solution-style root tsconfig.json with project references ([@nx/js:typescript-sync]: Missing root "tsconfig.json").

Workspaces created with @frontmcp/nx 1.8.7 or earlier register @nx/js/typescript, which makes nx build <app> fail once a library is in the graph and nx typecheck fail with TS5069. Remove the @nx/js/typescript entry from plugins in nx.json, then add a typecheck target to existing projects (or regenerate them):

"typecheck": {
  "executor": "nx:run-commands",
  "cache": true,
  "options": {
    "commands": ["tsc --noEmit -p tsconfig.lib.json", "tsc --noEmit -p tsconfig.spec.json"],
    "parallel": false,
    "cwd": "{projectRoot}"
  }
}

A library you publish loses the build target @nx/js/typescript inferred for it; give it the build target and package.json of a publishable library.

Get Started

Generators

Executors

Usage

Options

Generated Files

Example

​Usage

​Options

​Generated Files

​Example

Usage

Options

Generated Files

Example