pingcap/agent-rules

tidbx-serverless-driver

Guidance for using the TiDB Cloud Serverless Driver (Beta) in Node.js, serverless, and edge environments.

First seen Jan 27, 2026

Installation

$ npx skills add pingcap/agent-rules --skill tidbx-serverless-driver

Summary

  • 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.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from pingcap/agent-rules · top by installs.

npx skills add pingcap/agent-rules

Browse all from pingcap/agent-rules

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 25
Default branch main
Open issues 2
Status Active

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,603 B
  • docs SUMMARY.md 402 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 24 installs

SKILL.md

TiDB Cloud Serverless Driver (Beta)

Use this skill to guide users who need the TiDB Cloud serverless driver (Beta) in serverless or edge environments.

Introduction

Serverless and edge runtimes often do not support long-lived TCP connections. Traditional MySQL drivers expect TCP, so they are a poor fit there. The TiDB Cloud serverless driver (Beta) uses HTTP instead, so it works in serverless and edge environments while keeping a similar developer experience.

Install

npm install @tidbcloud/serverless

Tutorials (References)

Use the reference file for the canonical driver overview, examples, configuration, and limitations. Load only what you need, and use the table of contents to jump to the right section:

  • Source of truth: references/serverless-driver.md

Usage Guidance

  • Confirm the cluster type: Starter or Essential.
  • Ask which runtime they use: Node.js, Vercel Edge, Cloudflare Workers, Netlify, Deno, Bun.
  • Use the connection string from the TiDB Cloud console. In Connect, choose Serverless Driver, then generate/reset the password before copying DATABASE_URL.
  • For provisioning or cluster CRUD, use the tidbx skill.