surreal-skills

Expert SurrealDB 3 skill for AI coding agents. Tracks SurrealDB v3.1.4+. Complete coverage of SurrealQL, multi-model data modeling, graph traversal, vector search (HNSW + DiskANN), security, deployment, performance tuning, SDK integration, WASM extensions, built-in MCP (v3.1+), standalone SurrealMCP, SurrealKit, Surrealist, n8n, CodeMirror, and agent-skill workflows.

Features

• SurrealQL mastery -- Complete language reference with statements, functions, operators, and idioms
• Multi-model data modeling -- Document, graph, vector, relational, time-series, and geospatial patterns in a single schema
• Graph queries -- First-class edge creation and traversal without JOINs
• Vector search -- HNSW and DiskANN indexes, similarity functions, and RAG pipeline patterns
• Built-in MCP (v3.1+) -- surreal mcp stdio and HTTP /mcp for AI agent hosts; standalone surrealmcp for extended tools
• Security -- Row-level permissions, JWT auth, namespace/database/record-level access control
• Deployment -- Storage engine selection, Docker, Kubernetes, production hardening
• Performance -- Index strategies, EXPLAIN analysis, batch operations, connection pooling
• 12+ SDK integrations -- JavaScript/TypeScript, Python, Go, Rust, Java, Kotlin, .NET, C, PHP, Swift (iOS/macOS/visionOS), Ruby
• Surrealism WASM extensions -- Custom functions and analyzers compiled from Rust (new in v3)
• SurrealML scope coverage -- .surml artifact format (preview/unstable), PyPI-vs-GitHub release boundary, and native-library download warning
• SurrealMCP for AI agents -- Built-in MCP in SurrealDB 3.1+ plus standalone surrealdb/surrealmcp v0.4.0
• Editor tooling pointers -- first-party surrealql-language-server v0.1.6, tree-sitter grammar, CodeMirror v1.0.6, and discoverability pointers for VS Code / Cursor / Windsurf / VSCodium, JetBrains, Neovim, Helix, Sublime Text, Zed extensions
• LangChain integration (Python only) -- langchain-surrealdb 0.2.1 (Python) -- vector store usage; @langchain/surrealdb JS package was retracted in v1.4.1 (does not exist on npm)
• surrealdb/setup-surreal@v2 GitHub Action -- Official Action for running SurrealDB inside CI workflows (the v1.4.0 documentation that described setup-surreal as a CLI bootstrap was retracted in v1.4.2)
• Full ecosystem -- Surrealist IDE, Surreal-Sync CDC, SurrealFS agent filesystem, SurrealKit schema tooling, n8n community node, official Agent Skills repo, and Spectron roadmap boundary
• Health checks and introspection -- Doctor script and schema introspection for any SurrealDB instance
• Universal agent support -- Works with 30+ AI coding agents via skills.sh

Installation

Claude Code (recommended)

Option 1 -- Install as a Claude Code skill (global)

npx skills add 24601/surreal-skills -a claude-code -g -y

This installs the skill globally so it is available in every Claude Code session. The -g flag installs globally, -y auto-confirms prompts.

Option 2 -- Install per-project via CLAUDE.md

Clone the repo and reference it from your project's CLAUDE.md:

git clone https://github.com/24601/surreal-skills.git ~/.claude/skills/surrealdb

Then add to your project's CLAUDE.md (or ~/.claude/CLAUDE.md for global):

# SurrealDB Skill

@import ~/.claude/skills/surrealdb/AGENTS.md

Or inline the reference:

# SurrealDB Skill