Surrealmcp logo

Surrealmcp

Organization
skillmds
surrealmcp

SurrealDB 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.

Overview

Publisherskillmds
Repositoryskillmd
Skill namesurrealmcp
Stars
249
Forks
3
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by skillmds on GitHub. Read the source before you install it.

Installation

Install the Surrealmcp AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/skillmds/skillmd/tree/main/plugins/agents-mcp/skills/surrealmcp
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/skillmds/skillmd.git /tmp/skillmd
mkdir -p .claude/skills
cp -r /tmp/skillmd/plugins/agents-mcp/skills/surrealmcp .claude/skills/surrealmcp
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Surrealmcp in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Surrealmcp on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Surrealmcp is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

SurrealDB MCP for AI Agents

Two MCP surfaces exist as of SurrealDB 3.1:

SurfaceWhen to use
Built-in (surreal mcp, HTTP /mcp)Local IDE hosts; simplest setup with the main surreal binary
Standalone (surrealmcp start)Extended tool catalog, cloud helpers, multi-endpoint switching

Built-in MCP (SurrealDB 3.1+)

bash
# stdio — typical MCP host config
surreal mcp --endpoint ws://127.0.0.1:8000/rpc --ns test --db test \
  --user root --pass root

Security: stdio MCP grants owner-level tool access with no login step. Do not expose to untrusted hosts. HTTP /mcp requires normal SurrealDB authentication.

See rules/surrealmcp.md for env vars and tool hints.

Standalone surrealmcp (v0.4.0)

Not published to crates.io or npm. Install from source or Docker:

bash
git clone https://github.com/surrealdb/surrealmcp
cd surrealmcp && cargo install --path .

# Or Docker
docker run --rm -i --pull always surrealdb/surrealmcp:latest start \
  --endpoint ws://localhost:8000/rpc --ns test --db test

The start subcommand is mandatory. Full tool catalog and host wiring: rules/surrealmcp.md.

Frequently asked questions

What does the Surrealmcp AI skill do?

SurrealDB 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.

Why use Surrealmcp on TypingMind?

Because you install it once and use it with any model. Surrealmcp is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Surrealmcp in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/skillmds/skillmd/tree/main/plugins/agents-mcp/skills/surrealmcp. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Surrealmcp?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Surrealmcp?

As many as you like. As long as a model supports skills, you can use Surrealmcp with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Surrealmcp AI skill free?

Yes. It is published on GitHub by skillmds under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇