surrealmcp
starsforks
How to install surrealmcp?
24601/surreal-skills/surrealmcp
$npx -y skills add 24601/surreal-skills --skill surrealmcpSurrealDB MCP for AI agents: built-in server (SurrealDB 3.1+ surreal mcp) and standalone surrealmcp (surrealdb/surrealmcp v0.4.0). Part of the surreal-skills collection.
SKILL.md
| 1 | # SurrealDB MCP for AI Agents |
| 2 | |
| 3 | Two MCP surfaces exist as of SurrealDB 3.1: |
| 4 | |
| 5 | | Surface | When to use | |
| 6 | |---|---| |
| 7 | | **Built-in** (`surreal mcp`, HTTP `/mcp`) | Local IDE hosts; simplest setup with the main `surreal` binary | |
| 8 | | **Standalone** (`surrealmcp start`) | Extended tool catalog, cloud helpers, multi-endpoint switching | |
| 9 | |
| 10 | ## Built-in MCP (SurrealDB 3.1+) |
| 11 | |
| 12 | ```bash |
| 13 | # stdio — typical MCP host config |
| 14 | surreal mcp --endpoint ws://127.0.0.1:8000/rpc --ns test --db test \ |
| 15 | --user root --pass root |
| 16 | ``` |
| 17 | |
| 18 | **Security:** stdio MCP grants owner-level tool access with no login step. Do not |
| 19 | expose to untrusted hosts. HTTP `/mcp` requires normal SurrealDB authentication. |
| 20 | |
| 21 | See [rules/surrealmcp.md](../../rules/surrealmcp.md) for env vars and tool hints. |
| 22 | |
| 23 | ## Standalone surrealmcp (v0.4.0) |
| 24 | |
| 25 | Not published to crates.io or npm. Install from source or Docker: |
| 26 | |
| 27 | ```bash |
| 28 | git clone https://github.com/surrealdb/surrealmcp |
| 29 | cd surrealmcp && cargo install --path . |
| 30 | |
| 31 | # Or Docker |
| 32 | docker run --rm -i --pull always surrealdb/surrealmcp:latest start \ |
| 33 | --endpoint ws://localhost:8000/rpc --ns test --db test |
| 34 | ``` |
| 35 | |
| 36 | The `start` subcommand is mandatory. Full tool catalog and host wiring: |
| 37 | [rules/surrealmcp.md](../../rules/surrealmcp.md). |
People who liked this also viewed
6 picksType
- azure-storageAzure Storage Services including Blob Storage, File Shares, Queue Storage, Table Storage, and Data Lake. Answers questions about storage access tiers (hot, cool, cold, archive), when to use each tier,SkillsJul 2026
- supabase-postgres-best-practicesPostgres performance optimization and best practices from Supabase. Use this skill when writing, reviewing, or optimizing Postgres queries, schema designs, or database configurations.SkillsJul 2026
- supabaseUse when doing ANY task involving Supabase. Triggers: Supabase products (Database, Auth, Edge Functions, Realtime, Storage, Vectors, Cron, Queues); client libraries and SSR integrations (supabase-js, SkillsJul 2026
- convex-quickstartCreates or adds Convex to an app. Use for new Convex projects, npm create convex@latest, frontend setup, env vars, or the first npx convex dev run.SkillsJul 2026
- convex-performance-auditAudits Convex performance for reads, subscriptions, write contention, and function limits. Use for slow features, insights findings, OCC conflicts, or read amplification.SkillsJul 2026
- convex-setup-authSets up Convex auth, identity mapping, and access control. Use for login, auth providers, users tables, protected functions, or roles in a Convex app.SkillsJul 2026
