Databases·v1.7.1

SurrealDB 3 Agent Skill

Expert SurrealDB 3 architect and developer skill (tracks v3.1.4+).

Context cost
229.7k tokensestimated from the bundle; more than a 200k window holds
Bundle
50 files · 987.3 kB5 scripts among them — read before you run
Licence
MITthe author’s own terms
Last change
—v1.7.1
Servers it uses
Noneruns standalone

What it does

Expert SurrealDB 3 architect and developer skill (tracks v3.1.4+). SurrealQL mastery, multi-model data modeling (document, graph, vector, time-series, geospatial), schema design, security, deployment, performance tuning, SDK integration (JS, Python, Go, Rust, Java, .NET, C, PHP, Swift, Kotlin, Ruby), Surrealism WASM extensions, SurrealML scope coverage (preview), built-in MCP (v3.1+) and standalone SurrealMCP, LangChain Python integration, editor tooling (LSP v0.1.6, tree-sitter, CodeMirror v1.0.6, VS Code/JetBrains/Neovim/Zed), and ecosystem integrations (Surrealist v3.9, Surreal-Sync…

What this skill changes about the agent has not been set out here as a list. Its SKILL.md, shown below, says it in the author’s own words.

database
Filed under

Databases

The skill itself

A skill is instructions the model reads, so you can see what you are getting: below is the start of its SKILL.md. The front matter loads with every session, the body loads when the skill triggers, and the whole file comes with the install.

SKILL.md20.8 kB · preview
--- name: surrealdb version: "1.7.1" license: MIT metadata: version: "1.7.1" author: "24601" snapshot_date: "2026-06-17" repository: "https://github.com/24601/surreal-skills" openclaw: requires: env: - SURREAL_ENDPOINT - SURREAL_USER - SURREAL_PASS - SURREAL_NS - SURREAL_DB bins: - surreal - python3 - uv primaryEnv: SURREAL_PASS homepage: "https://github.com/24601/surreal-skills" always: false install: - kind: brew formula: surrealdb/tap/surreal bins: [surreal] - kind: brew formula: uv bins: [uv] requires: binaries: - name: surreal install: "brew install surrealdb/tap/surreal" purpose: "SurrealDB CLI for server management, SQL REPL, import/export" optional: false - name: python3 version: ">=3.10" purpose: "Required for skill scripts (doctor.py, schema.py, onboard.py)" optional: false - name: uv install: "brew install uv" purpose: "PEP 723 script runner -- installs script deps automatically" optional: false - name: docker purpose: "Containerized SurrealDB instances" optional: true - name: gh install: "brew install gh" purpose: "GitHub CLI -- used only by check_upstream.py for comparing upstream repo SHAs" optional: true env_vars: - name: SURREAL_ENDPOINT purpose: "SurrealDB server URL" default: "http://localhost:8000" sensitive: false - name: SURREAL_USER purpose: "Authentication username" default: "root" sensitive: true - name: SURREAL_PASS purpose: "Authentication password" default: "root" sensitive: true - name: SURREAL_NS purpose: "Default namespace" default: "test" sensitive: false - name: SURREAL_DB purpose: "Default database" default: "test" sensitive: false security: no_network: false no_network_note: "doctor.py and schema.py connect to a user-specified SurrealDB endpoint (WebSocket) for health checks and schema introspection. check_upstream.py calls GitHub API via gh CLI to compare upstream repo SHAs. No other third-party network calls." no_credentials: false no_credentials_note: "Scripts accept SURREAL_USER/SURREAL_PASS for DB authentication. No credentials are stored in the skill itself." no_env_write: true no_file_write: false no_file_write_note: "schema.py can write exported schema files when --output-dir is set. onboard.py can write a local .env file during interactive setup if the user explicitly confirms." no_shell_exec: false no_shell_exec_note: "Scripts invoke surreal CLI and gh for health checks." scripts_auditable: true scripts_use_pep723: true no_obfuscated_code: true no_binary_blobs: true no_minified_scripts: true no_curl_pipe_sh: true ---
93# SurrealDB 3 Skill
94
95Expert-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.
96
97## For AI Agents
98
99Get a full capabilities manifest, decision trees, and output contracts:
100
101```bash
102uv run {baseDir}/scripts/onboard.py --agent
103```
104
105See [AGENTS.md]({baseDir}/AGENTS.md) for the complete structured briefing.
106
107| Command | What It Does |
108|---------|-------------|
109| uv run {baseDir}/scripts/doctor.py | Health check: verify surreal CLI, connectivity, versions |
110| uv run {baseDir}/scripts/doctor.py --check | Quick pass/fail check (exit code only) |
111| uv run {baseDir}/scripts/schema.py introspect | Dump full schema of a running SurrealDB instance |
This is a preview of SKILL.md. Download or install the skill to get the whole thing.
In the file
SKILL.md2,538 words
Files50
LicenceMIT
Why you can read it

Nothing in a skill executes. The client loads the text and the model follows it, so a skill can be audited the way a runbook is — by reading it.

What it costs in context

Skills are not billed by the call. They are paid for in context: every token the instructions occupy is a token your code, your diff and your conversation cannot use. Here is what this one takes and when it takes it.

≈900
always loaded
The name and description, so the model knows the skill exists and when to reach for it.
228,775
on trigger
The instruction body and 49 supporting files, read only when the skill fires.
1.1×
a 200k window
It does not fit in the window: loaded whole, it would need more room than the model has.
050k100k150k200k context window

229.7k tokens, estimated from the bundle at four bytes to the token — more than the whole window, so it cannot all be held at once: the model reads SKILL.md when the skill fires and the other files only as the instructions call for them. Heavy. Teams tend to install this one per project rather than globally, and load it only when the job comes up.

Servers bill, skills cost

A server charges by the month. A skill charges once per session, in context, and then keeps charging it for as long as the session lives.

Before and after

The same question, put to the same model twice: once as it comes, and once with these instructions loaded.

No worked example has been published for this skill yet.

The procedure it runs

The procedure has not been set out here step by step. It is in the body of its SKILL.md: the start of it is shown above, and the whole file comes with the install.

Prose, not code

These steps are written for a model to follow, not executed by a runtime. It can still be told to skip one, and it will say so when it does.

Servers it uses

None. This skill calls no MCP servers at all.

Everything it needs is in the instructions, so it works in a project with nothing connected — the model reads the file and changes how it works with what it can already reach.

Its SKILL.md does not declare which tools it asks the agent for, so what it touches is whatever the instructions themselves ask for — read them before you install it.

What it asks for
Writes filesnot declared
Network accessnot declared

This SKILL.md carries no allowed-tools line, so neither is declared. A skill grants no permissions of its own — it can only ask for tools your client already has.

What it will not do

Every skill is narrow, and the useful ones say where they stop. These are the jobs this one is the wrong tool for.

What this skill is not for has not been published here. Nothing is implied by that: it is a section the author has not filled in.

What is in the bundle

50 files, 987.3 kB on disk. Mostly text — the instructions the model reads — with 5 scripts in it that your client would run only if the instructions tell it to. 1 file of its source is not in the download — listed after these, with why.

  • SKILL.md20.8 kB
  • AGENTS.md26.9 kB
  • CHANGELOG.md191.8 kB
  • CONTRIBUTING.md4.3 kB
  • LICENSE1.1 kB
  • README.md28.8 kB
  • SECURITY.md2.8 kB
  • SOURCES.json12.7 kB
  • .github/PULL_REQUEST_TEMPLATE.md1.1 kB
  • notes/v1.5.x-convergence.md10.0 kB
  • notes/v1.6.2-ratification.md11.2 kB
  • notes/v1.6.5-ratification.md13.1 kB
  • references/online_docs.md4.5 kB
  • references/surrealql_cheatsheet.md7.1 kB
  • rules/data-modeling.md67.0 kB
  • rules/deployment.md24.9 kB
  • rules/ecosystem-integrations.md5.9 kB
  • rules/editor-tooling.md16.0 kB
  • rules/gotchas.md7.7 kB
  • rules/graph-queries.md34.7 kB
  • rules/langchain.md6.5 kB
  • rules/performance.md36.9 kB
  • rules/sdks.md52.8 kB
  • rules/security.md73.4 kB
  • rules/surreal-sync.md13.0 kB
  • rules/surrealfs.md12.0 kB
  • rules/surrealism.md11.1 kB
  • rules/surrealist.md8.1 kB
  • rules/surrealkit.md6.9 kB
  • rules/surrealmcp.md12.3 kB
  • rules/surrealml.md11.3 kB
  • rules/surrealql.md102.3 kB
  • rules/vector-search.md38.6 kB
  • scripts/check_upstream.py7.2 kB
  • scripts/check_version_consistency.py5.2 kB
  • scripts/doctor.py15.6 kB
  • scripts/onboard.py16.4 kB
  • scripts/schema.py24.2 kB
  • .github/ISSUE_TEMPLATE/bug_report.md0.8 kB
  • .github/ISSUE_TEMPLATE/config.yml0.3 kB
  • .github/ISSUE_TEMPLATE/feature_request.md1.6 kB
  • .github/workflows/ci.yml4.9 kB
  • .github/workflows/release.yml6.5 kB
  • .github/workflows/upstream-check.yml4.2 kB
  • skills/surreal-sync/SKILL.md3.6 kB
  • skills/surrealfs/SKILL.md5.2 kB
  • skills/surrealism/SKILL.md3.1 kB
  • skills/surrealkit/SKILL.md3.5 kB
  • skills/surrealmcp/SKILL.md1.7 kB
  • .github/skills/surrealdb/SKILL.md5.7 kB

Not in the download

Not carried is a type a skill download does not hold. Take it from its source.

  • .gitignorenot carried
What is not in it

A skill installs nothing and depends on nothing: it is a folder your client reads. This one carries 5 scripts beside the text, so the download is 50 files — not the whole of its source: 1 file is left out. It is listed under the files, with why. The MIT licence covers the templates and examples as well as the instructions.

Install

Installing copies the bundle into your project. Nothing runs at install time — the files sit on disk until the model reads them.

# SurrealDB 3 · 229.7k tokens when loaded · macOS, Linux mkdir -p .claude/skills && t=$(mktemp -d) && curl -fsSL -o "$t/bundle.tar.gz" https://mcprush.com/api/skills/surrealdb-3/bundle.tar.gz && tar -xzf "$t/bundle.tar.gz" -C "$t" && [ -d "$t/surrealdb-3" ] && { [ ! -e .claude/skills/surrealdb-3 ] || { mv .claude/skills/surrealdb-3 "$t/.previous" && echo "Previous copy moved to $t/.previous"; }; } && mv "$t/surrealdb-3" .claude/skills/ && echo "Installed .claude/skills/surrealdb-3"
On Windows, or any OS with Node 20+
npx mcprush@latest skill add 24601/surrealdb-3

Windows PowerShell says 'running scripts is disabled on this system'? Run Set-ExecutionPolicy -Scope CurrentUser RemoteSigned once, or type npx.cmd instead of npx (codex.cmd, gemini.cmd, grok.cmd likewise). PowerShell 7 needs neither. Writes to .claude/skills/surrealdb-3/ in the current project. For every project instead, run mkdir -p ~/.claude/skills && t=$(mktemp -d) && curl -fsSL -o "$t/bundle.tar.gz" https://mcprush.com/api/skills/surrealdb-3/bundle.tar.gz && tar -xzf "$t/bundle.tar.gz" -C "$t" && [ -d "$t/surrealdb-3" ] && { [ ! -e ~/.claude/skills/surrealdb-3 ] || { mv ~/.claude/skills/surrealdb-3 "$t/.previous" && echo "Previous copy moved to $t/.previous"; }; } && mv "$t/surrealdb-3" ~/.claude/skills/ && echo "Installed ~/.claude/skills/surrealdb-3" (macOS, Linux) — or add --global to the npx line. The curl line replaces .claude/skills/surrealdb-3/ only after the download succeeds, so files left there by another skill of the same name, or by an older release, do not mix in. A copy already there is moved aside, not deleted, and the line prints where. It appears as surrealdb in Gemini CLI, Codex, Copilot and Grok (its own name); Claude Code lists it by the folder name, surrealdb-3. Not in this download: 1 file of its source (which one, and why). Take it from its source.

Which clients pick it up on their own

A skill is a folder of text. Most of these read a skills folder and pick it up without being told; the rest take the same folder another way — an upload in the app, a parameter on an API call — and then choose it by its description just the same.

Claude Code.claude/skills/
Claude DesktopCustomize › Skills
ChatGPTSkills › Create › Upload
Cursor.cursor/skills/
VS Code.github/skills/
Codex CLI.agents/skills/
Gemini CLI.gemini/skills/
Grok Build.grok/skills/
Microsoft CopilotSkills › Upload a skill
PerplexityComputer › Skills › Upload a skill
DeepSeek Harness.dsh/skills/
Zed.agents/skills/
Devin Desktop.devin/skills/
Windsurf (legacy).windsurf/skills/
OpenAI Agents SDKInstructions or sandbox Skills
HTTP / APIa request parameter
This release
Version1.7.1
Publishedno release date on file
PriceFree
Reference24601/surrealdb-3

Versions

v1.7.1 is what is on the shelf; no release here carries a date. Instructions change more often than APIs do — a skill can be rewritten entirely without anything it depends on moving.

v1.7.1
  • No earlier releases have been published to the marketplace.
Pinning

The install command always fetches the release that is current the day you run it — v1.7.1 today — and cannot ask for an earlier one. The copy on your disk does not change until you run it again.

Reviews

—no reviews yet

Nobody has reviewed this skill yet. The rating is the mean of the reviews written here, so there is none until somebody writes the first.

Sign in to review it

A review is tied to an account so it can be answered, edited and taken down by the person who wrote it.

Sign in
Who can post

Anybody with an account, one review each. It carries the version that was current when you wrote it, and the publisher may reply once.

Who wrote it

24
24601

Publishes on mcprush.

0 servers listed1 skill listednot claimed
Profile
Publisher
Servers0
Claim this skill