Agent skill
frontmcp-setup
Domain router for project setup, scaffolding, and organization. Use this skill whenever someone asks to create a new FrontMCP project, set up an Nx monorepo, configure Redis or SQLite storage, organize project structure, compose multiple apps into one server, or manage the skills system. Also triggers for questions like 'how do I start', 'project layout', 'folder structure', 'add redis', 'set up database', or 'create a new app'.
Install this agent skill to your Project
npx add-skill https://github.com/agentfront/frontmcp/tree/main/libs/skills/catalog/frontmcp-setup
Metadata
Additional technical details for this skill
SKILL.md
FrontMCP Setup Router
Entry point for project setup and scaffolding. This skill helps you find the right setup guide based on your project needs — from initial scaffolding to storage backends, project structure, and multi-app composition.
When to Use This Skill
Must Use
- Starting a new FrontMCP project from scratch and need to choose between standalone vs Nx monorepo
- Setting up storage backends (Redis, SQLite) for session or state management
- Organizing an existing project and need canonical directory layout guidance
Recommended
- Onboarding to the FrontMCP project structure and naming conventions
- Setting up multi-app composition within a single server
- Understanding the skills system and how to browse, install, and manage skills
Skip When
- You need to build specific components like tools or resources (see
frontmcp-development) - You need to configure transport, auth, or throttling (see
frontmcp-config) - You need to deploy or build for a target platform (see
frontmcp-deployment)
Decision: Use this skill when you need to CREATE or ORGANIZE a project. Use other routers when you need to build, configure, deploy, or test.
Prerequisites
- Node.js 24+ and npm/yarn installed
frontmcpCLI available globally (npm install -g frontmcp)
Steps
- Use the Scenario Routing Table below to find the right setup guide for your task
- Scaffold your project with
frontmcp create(standalone) orfrontmcp create --nx(monorepo) - Configure storage and project structure per the relevant reference files
- Follow the Recommended Reading Order for a complete setup walkthrough
Scenario Routing Table
| Scenario | Reference | Description |
|---|---|---|
Scaffold a new project with frontmcp create |
references/setup-project.md |
CLI scaffolder (flags: --target, --redis, --skills <bundle>, --cicd, --nx, --pm) |
| Organize a standalone (non-Nx) project | references/project-structure-standalone.md |
File layout, naming conventions (<name>.<type>.ts), folder hierarchy |
| Organize an Nx monorepo | references/project-structure-nx.md |
apps/, libs/, servers/ layout, generators, dependency rules |
| Set up Redis for production storage | references/setup-redis.md |
Docker Redis, Vercel KV, pub/sub for distributed subscriptions (single-server uses in-memory) |
| Set up SQLite for local development | references/setup-sqlite.md |
WAL mode, migration helpers, encryption |
| Compose multiple apps into one server | references/multi-app-composition.md |
@FrontMcp with multiple @App classes, cross-app providers |
| Use Nx build, test, and CI commands | references/nx-workflow.md |
nx build, nx test, nx run-many, caching, affected commands |
| Browse, install, and manage skills | references/frontmcp-skills-usage.md |
CLI commands, bundles, categories, search |
| Generate or update project README.md | references/readme-guide.md |
Deployment-target-aware README for npm, CLI, Docker, serverless |
Recommended Reading Order
references/setup-project.md— Start here for any new projectreferences/project-structure-standalone.mdorreferences/project-structure-nx.md— Choose your layoutreferences/setup-redis.mdorreferences/setup-sqlite.md— Add storage if neededreferences/multi-app-composition.md— Scale to multiple apps (when needed)references/nx-workflow.md— Nx-specific build and CI commands (if using Nx)references/frontmcp-skills-usage.md— Learn the skills systemreferences/readme-guide.md— Generate README for your deployment target
Cross-Cutting Patterns
| Pattern | Rule |
|---|---|
| Project type | Standalone for single-app projects; Nx for multi-app or team projects |
| File naming | <name>.<type>.ts (e.g., fetch-weather.tool.ts) everywhere |
| Test naming | .spec.ts extension (not .test.ts) |
| Entry point | main.ts must export default the @FrontMcp class |
| Storage choice | Redis for production/serverless; SQLite for local dev/CLI; memory for tests only |
| App boundaries | Each @App is a self-contained module; shared logic goes in providers |
Common Patterns
| Pattern | Correct | Incorrect | Why |
|---|---|---|---|
| Project scaffolding | frontmcp create or frontmcp create --nx |
Manual setup from scratch | CLI sets up correct structure, dependencies, and config files |
| Entry point | export default class MyServer in main.ts |
Named export or no default export | FrontMCP loads the default export at startup |
| Storage in production | Redis or platform-native (Vercel KV, DynamoDB) | Memory store or SQLite | Memory is lost on restart; SQLite doesn't work on serverless |
| Multi-app composition | Separate @App classes composed in @FrontMcp |
One giant @App with all components |
Separate apps enable independent testing and modular architecture |
| File organization | Feature folders for 10+ components | Flat tools/ directory with dozens of files |
Feature folders make domain boundaries visible |
Verification Checklist
Project Structure
-
main.tsexists withexport defaultof@FrontMcpclass - At least one
@Appclass registered in the server - Files follow
<name>.<type>.tsnaming convention - Test files use
.spec.tsextension
Storage
- Storage backend chosen and configured (Redis/SQLite/memory)
- Connection string in environment variables, not hardcoded
- Storage accessible from the server process
Build and Dev
-
frontmcp devstarts successfully with file watching -
frontmcp build --target <target>completes without errors - Tests pass with
frontmcp testornx test
Troubleshooting
| Problem | Cause | Solution |
|---|---|---|
frontmcp create fails |
Missing Node.js 24+ or npm/yarn | Install Node.js 24+ and ensure npm/yarn is available |
| Server fails to start | main.ts missing default export |
Add export default MyServerClass to main.ts |
| Redis connection refused | Redis not running or wrong URL | Start Redis (docker compose up redis) or fix REDIS_URL env var |
| Nx generator not found | @frontmcp/nx not installed |
Run npm install -D @frontmcp/nx |
| Skills not loading | Skills placed in wrong directory | Catalog skills go in top-level skills/, app skills in src/skills/ |
Reference
- Getting Started
- Domain routers:
frontmcp-development,frontmcp-deployment,frontmcp-testing,frontmcp-config,frontmcp-guides
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
docs-skill
A fixture skill with references and examples for E2E testing.
fix-pr
Review a CodeRabbit PR comment and produce an action plan when prompted to analyze a review comment.
frontmcp-observability
Use when you want to add tracing, structured logging, or monitoring to your FrontMCP server. Covers OpenTelemetry instrumentation, vendor integrations (Coralogix, Datadog, Logz.io, Grafana), this.telemetry API for custom spans, structured JSON logging with sinks, and testing observability. Triggers: observability, telemetry, tracing, logging, monitoring, opentelemetry, otel, spans, datadog, coralogix, logz, grafana, winston, pino.
frontmcp-development
Use when you want to create a tool, add a resource, build a prompt, write a provider, implement an adapter, add OpenAPI integration, create a plugin, agent, job, or workflow. The skill for BUILDING any FrontMCP component.
frontmcp-authorities
Use when implementing authorization, access control, RBAC, ABAC, or ReBAC for tools, resources, or prompts. Covers JWT claims mapping, authority profiles, and policy enforcement.
frontmcp-config
Use when you want to configure auth, set up CORS, add rate limiting, throttle requests, manage sessions, choose transport, set HTTP options, add authentication, configure JWT, or set up OAuth. The skill for server CONFIGURATION.
Didn't find tool you were looking for?