# tidbx-serverless-driver

Guides use of the TiDB Cloud serverless HTTP driver (Beta) in serverless and edge runtimes like Vercel, Cloudflare and Deno.

Skill by PingCAP (TiDB). Category: Data and backend.

## Install

Project (for this project only):

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

Works with: Claude Code, Codex CLI, Cursor, Antigravity, Copilot CLI, opencode.

Global (for every project on this machine):

```sh
npx skills add pingcap/agent-rules --skill tidbx-serverless-driver -g
```

Works with: Claude Code, Codex CLI, Cursor, Antigravity, Copilot CLI, opencode.

## Tags

- Runs on your computer: It runs as a program on your machine, with your access.

## Security audits

- Gen Agent Trust Hub: Pass
- Socket: Pass
- Snyk: Pass
- Runlayer: Pass

Installs: 24. Installs counted by skills.sh. [Open on skills.sh](https://www.skills.sh/pingcap/agent-rules/tidbx-serverless-driver)

## Source

[Open the source](https://github.com/pingcap/agent-rules/tree/HEAD/skills/tidbx-serverless-driver). Checked 2026-10-10. This summary may contain AI-generated text, so it can be wrong. Check the source before you rely on it.

## SKILL.md

````markdown
---
name: tidbx-serverless-driver
description: 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.
---

# 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.
````

- Previous: [remotion-multimedia](https://syn4pse.dev/terminal/remotion-multimedia.md)
- Next: [tidbx](https://syn4pse.dev/terminal/tidbx.md)
- [Terminal](https://syn4pse.dev/terminal.md)
- [Suggest a change](mailto:terminal@syn4pse.dev?subject=Terminal%20suggestion)
