A development guide for SurrealDB 3, a database that can store and query document, graph, vector, time-series and location-based data. It covers query writing, schema design, security, deployment, performance and application-library integration.

Use it to design schemas, write SurrealQL queries, inspect databases, tune performance, configure security and connect applications in supported programming languages.

It helps developers make database design and operational decisions for SurrealDB without treating it like a conventional database system.

surrealdb — Skill for Claude Code by skillmds/skillmd

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent

npx skills add skillmds/skillmd --skill surrealdb

Clone the repo

git clone --depth 1 https://github.com/skillmds/skillmd

Made for: Claude Code.

Or install data-ml, the plugin that ships this one along with the rest of its 17 skills.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/skills/skillmds/skillmd/surrealdb/github.svg)](https://agentmods.dev/skills/skillmds/skillmd/surrealdb)

Your own site

<a href="https://agentmods.dev/skills/skillmds/skillmd/surrealdb"><img src="https://agentmods.dev/badge/skills/skillmds/skillmd/surrealdb/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/skills/skillmds/skillmd/surrealdb"><img src="https://agentmods.dev/badge/skills/skillmds/skillmd/surrealdb.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 204 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 5,462 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00204	$0.05462
Opus 5.5	$0.00082	$0.02185
Sonnet 5.5	$0.00041	$0.01092
Haiku 4.5	$0.00020	$0.00546

Measured 1mo ago against content hash 40c79d8c64fd, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

surrealdb scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

surrealdb — 100% identical, 1 lines differ

plugins/data-ml/skills/surrealdb/SKILL.md · 442 lines

How it starts

The opening of the file, as written. The whole thing — 442 lines — stays where its author put it; the contents beside it link to each section on GitHub.

SurrealDB 3 Skill

Expert-level SurrealDB 3 architecture, development, and operations. Covers SurrealQL, multi-model data modeling, graph traversal, vector search, security, deployment, performance tuning, SDK integration, and the wider SurrealDB ecosystem, including SurrealKit, SurrealMCP, n8n, CodeMirror, and agent-skill surfaces.

For AI Agents

Get a full capabilities manifest, decision trees, and output contracts:

uv run {baseDir}/scripts/onboard.py --agent

See AGENTS.md for the complete structured briefing.

Command	What It Does
`uv run {baseDir}/scripts/doctor.py`	Health check: verify surreal CLI, connectivity, versions
`uv run {baseDir}/scripts/doctor.py --check`	Quick pass/fail check (exit code only)
`uv run {baseDir}/scripts/schema.py introspect`	Dump full schema of a running SurrealDB instance
`uv run {baseDir}/scripts/schema.py tables`	List all tables with field counts and indexes
`uv run {baseDir}/scripts/onboard.py --agent`	JSON capabilities manifest for agent integration

Prerequisites

surreal CLI -- brew install surrealdb/tap/surreal (macOS) or see install docs
Python 3.10+ -- Required for skill scripts
uv -- brew install uv (macOS) or pip install uv or see uv docs

Optional:

Docker -- For containerized SurrealDB instances (docker run surrealdb/surrealdb:v3)
SDK of choice -- JavaScript, Python, Go, Rust, Java, Kotlin, .NET, C, PHP, Swift, or Ruby

Security note: This skill documents package-manager and container installs only. Prefer auditable installs through Homebrew, apt/dnf, Cargo, npm, or Docker rather than remote one-line shell installers.

Quick Start

Credential warning: Examples below use root/root for local development only. Never use default credentials against production or shared instances. Create scoped, least-privilege users for non-local environments.

Read the full file on GitHub · 442 lines

Files

What ships with it

8 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

1mo ago First seen · 442 lines · 204 tokens per session scan A 40c79d8c64fd

Subscribe to this mod's changes

surrealdb is a skill published in the GitHub repository skillmds/skillmd (143 stars, last pushed 4d ago), licensed MIT. It adds 204 tokens to every session and 5,462 once invoked, about $0.0008 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-19.

Databases Lint agent-skills ai-agents claude cli mcp

surrealdb next to 6 skills from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
surrealdbskillmds/skillmd	Skill	143	4d ago	MIT	A	204	Claude Code
obsidian-baseskepano/obsidian-skills	Skill	51k	1mo ago	MIT	A	63	Claude Code
x-osvx-cmd/x-cmd	Skill	4.7k	7d ago	Apache-2.0	A	72	Claude Code, Codex
building-agentsericrisco/rsc-harness	Skill	529	3d ago	MIT	A	85	Claude Code, Codex
postgresdbericrisco/rsc-harness	Skill	529	3d ago	MIT	A	91	Claude Code, Codex
db-migrationsericrisco/rsc-harness	Skill	529	3d ago	MIT	A	90	Claude Code, Codex
firebaseericrisco/rsc-harness	Skill	529	3d ago	MIT	A	77	Claude Code, Codex