pingcap/tidbx-nextjs
skills/tidbx-nextjs/SKILL.md
Build and deploy Next.js (App Router) apps that connect to TiDB. Covers Route Handlers (app/api/*/route.ts), Node vs Edge runtime selection for database access, environment variable handling, and production-safe DB patterns on Vercel/serverless. Prefer Prisma/Kysely integration, with optional mysql2 for minimal examples. Includes guides and TypeScript templates.
$ install --global
skillsauthnpx skillsauth add pingcap/agenticstore tidbx-nextjsInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 15, 2026, 9:45 AM253.6s7 files scanned
SKILL.md
- name:
- tidbx-nextjs
- description:
- Build and deploy Next.js (App Router) apps that connect to TiDB. Covers Route Handlers (app/api/*/route.ts), Node vs Edge runtime selection for database access, environment variable handling, and production-safe DB patterns on Vercel/serverless. Prefer Prisma/Kysely integration, with optional mysql2 for minimal examples. Includes guides and TypeScript templates.
TiDB Next.js Integration
Set up a Next.js app (App Router) that connects to TiDB, with clear guidance on where database code can run (Node runtime) and how to avoid common serverless pitfalls.
What is different about Next.js (vs plain Node scripts)
- Full-stack framework: UI and server code live in one project.
- Server/client split: database code must stay server-side (route handlers, server components, server actions).
- Multiple runtimes: some routes can run on Edge; TCP database clients must run on Node runtime.
- File-based routing: API endpoints are files like
app/api/*/route.ts.
When to use this skill
- Build a new Next.js app that reads/writes TiDB
- Add TiDB to an existing Next.js App Router project
- Deploy to Vercel (or other serverless platforms) and avoid connection/caching/runtime issues
- Decide between Prisma/Kysely vs direct mysql2
Key decisions (recommended defaults)
- Prefer an ORM/query builder for application code:
- Prisma ORM:
tidbx-prisma - Kysely query builder:
tidbx-kysely
- Prisma ORM:
- Use a direct driver (
mysql2) only for minimal demos or when you need raw SQL without an ORM. - Run TCP database clients in the Node.js runtime (not Edge).
TiDB Cloud pool settings (mysql2)
- If you use a connection pool against TiDB Cloud, set the pool idle timeout to <= 300s (e.g.
idleTimeout: 300_000). - Keep the pool small in serverless environments (often
connectionLimit: 1is enough per function/container).
Available guides
guides/quickstart.md-- create a Next.js app and add TiDB (Prisma-first; mysql2 alternative)guides/troubleshooting.md-- runtime/env/caching/connection issues
Quick examples
- "Add a /api/health route that queries TiDB" -> route handler + pooled connection
- "Use Prisma in Next.js and deploy to Vercel" -> prisma singleton + route handlers
- "My route handler fails on Vercel Edge" -> force Node runtime or switch to serverless HTTP driver
Templates
templates/route-handler-mysql2.ts-- App Router Route Handler that queries TiDB with mysql2 (Node runtime)templates/tidb-mysql2-pool.ts-- mysql2 pool helper with TLS and serverless-friendly defaultstemplates/prisma-client.ts-- PrismaClient singleton for Next.js (dev hot reload safe)templates/route-handler-prisma.ts-- Route Handler using Prisma ($queryRaw + CRUD)
Related skills
tidbx-prisma-- Prisma ORM (models + migrations + typed client)tidbx-kysely-- Kysely (typed query builder)tidbx-serverless-driver-- TiDB Cloud serverless HTTP driver (for edge-like runtimes)tidbx-- provision/manage TiDB Cloud clusters
Workflow
I will:
- Confirm your Next.js routing mode (App Router) and runtime target (Node serverless vs Edge)
- Confirm your TiDB deployment (TiDB Cloud vs self-managed) and endpoint type (public vs private)
- Recommend Prisma/Kysely by default, unless you explicitly want mysql2
- Generate the minimal files (route handler + db client helper) and env vars to get you running
Related Skills
pingcap/tidbx
devops
VerifiedTrustedCommunity
Provision TiDB Cloud Serverless clusters and related resources. Use when creating, deleting, or listing clusters/branches, or managing SQL users via the console.
23SKILL.mdUpdated Apr 15, 2026
pingcap/tidbx-serverless-driver
devops
VerifiedTrustedCommunity
Guidance for using the TiDB Cloud Serverless Driver (Beta) in Node.js, serverless, and edge environments. Use when connecting to TiDB Cloud Starter/Essential over HTTP with @tidbcloud/serverless, or when integrating with Prisma/Kysely/Drizzle serverless adapters in Vercel/Cloudflare/Netlify/Deno/Bun. Use this skill for serverless driver setup and edge runtime guidance.
23SKILL.mdUpdated Apr 15, 2026
pingcap/tidbx-prisma
tools
VerifiedTrustedCommunity
Prisma ORM setup and usage for TiDB from Node.js/TypeScript. Covers configuring prisma/schema.prisma (MySQL provider), DATABASE_URL formatting for TiDB Cloud TLS (sslaccept=strict and optional sslcert), migrations (prisma migrate), Prisma Client generation, CRUD patterns, and safe raw SQL ($queryRaw) plus runnable templates.
23SKILL.mdUpdated Apr 15, 2026
pingcap/tidbx-kysely
testing
VerifiedTrustedCommunity
Set up Kysely with TiDB Cloud (TiDB X), including @tidbcloud/kysely over the TiDB Cloud serverless HTTP driver for serverless or edge environments, plus standard TCP usage. Use for Kysely + TiDB Cloud connection setup, demo snippets, and environment-specific guidance.
23SKILL.mdUpdated Apr 15, 2026