skills.rest
serverpod
serverpodOFFICIAL
Explore all skills by this author →
Website𝕏@ServerpodDevGitHub

serverpod-overview

Guide Serverpod project setup, code generation, and runtime workflows.

3.2k|369|Updated May 22, 2021
Search Tags:#migrations#code generation#dart#hot reload#serverpod#flutter backend#rpc endpoints
One-click install
npx skills add https://github.com/serverpod/serverpod --skill serverpod-overview
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: serverpod-overview
Source: https://github.com/serverpod/serverpod/tree/main/packages/serverpod/skills/serverpod-overview
Command: npx skills add https://github.com/serverpod/serverpod --skill serverpod-overview

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents confusion and wasted time by giving a clear, practical walkthrough of how to structure and operate a typical Serverpod project.

Core Features & Use Cases

  • Project structure guidance: Explains the usual tri-package layout (server, generated client, Flutter app) and optional shared packages, so you know where changes belong.
  • How server endpoints and generation work: Clarifies that endpoint methods drive generated RPC client APIs and that models defined in YAML generate Dart code for both server and client.
  • Operational workflow for safe development: Advises how to run with hot reload, when to avoid starting manually, and how to use the MCP server for migrations, log inspection, and hot restarts.
  • Use case focus: Helps you quickly adopt Serverpod’s built-in capabilities like ORM, caching, real-time streaming, file uploads, scheduling, logging, and the Relic web server by linking them to dedicated follow-up skills.

Quick Start

Tell the AI: "Give me a concise plan for where to make changes in a Serverpod project, how to run code generation safely, and when I should use MCP hot_restart."

Frequently Asked Questions about serverpod-overview

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure a Flutter backend project using Serverpod?▼

A typical Serverpod project uses a tri-package layout: the server, a generated client, and the Flutter app, with optional shared packages. This structure ensures you know exactly where endpoint updates and data model changes belong during development.

How does code generation work for Serverpod RPC endpoints?▼

Code generation for Serverpod RPC endpoints works by using your server endpoint methods to automatically generate the client APIs. Defining data models in YAML generates the necessary Dart code for both the server and client sides.

What is the best way to run Serverpod migrations safely?▼

The best way to run Serverpod migrations safely is by using the MCP server workflow rather than starting processes manually. This approach ensures migrations are tracked properly without manually editing generated code.

Can I use hot reload with Dart during Serverpod development?▼

Yes, you can use hot reload with Dart during Serverpod development by utilizing the MCP server's hot_restart capability. This allows you to inspect logs and apply runtime changes efficiently without manually restarting the server.

Why should I avoid editing generated code manually in a Serverpod project?▼

You should avoid editing generated code manually because Serverpod relies on an automated generation flow for endpoints and models. Manual edits will be overwritten during the generation cycle, breaking the synchronization between server and client code.

Related Skills

Explore More Software Engineering Skills→
aaronbassettaaronbassett
4

flutter-core:flutter-serverpod

Build Flutter backends with Serverpod typed models, endpoints, and authentication.

Community
Advanced
AntonySilverhandAntonySilverhand

slide-theme

Apply BPDU branding to an existing HTML slide deck via CSS tokens and brand bar edits.

Community
Intermediate
serverpodserverpod
3.2k

serverpod-webserver

Implement Relic-based HTTP routing and static asset serving for Serverpod applications.

Official
Intermediate
TheCraigHewittTheCraigHewitt
7.3k

analytics-tracking

Design and implement GA4 and GTM analytics tracking with event taxonomy and privacy compliance.

Community
Intermediate