Skip to content
Sign In

Agent setup

Claude Code

Set up Claude Code for SurrealDB with the hosted MCP server and the official Agent Skills.

Claude Code is Anthropic's terminal coding agent. With the SurrealDB MCP server connected it can deploy and manage your Cloud instances and query the data inside them, and with the skills installed the SurrealQL it writes matches how the database actually behaves.

claude mcp add --transport http surrealdb https://mcp.surrealdb.com

Add --scope project to write the entry to .mcp.json in the repository instead of your global configuration. The file holds no credentials, so it is safe to commit; everyone who opens the project signs in as themselves.

Run /mcp inside Claude Code, choose surrealdb, and approve the connection in the browser window that opens. Until you sign in, only the sign-in tool works.

If you are running somewhere without a browser, create a personal access token and pass it as a header instead:

claude mcp add --transport http surrealdb https://mcp.surrealdb.com \
  --header "Authorization: Bearer <your-token>"

Run this in your project root:

npx skills add surrealdb/agent-skills

Claude Code reads the installed skills automatically and picks one up when a task calls for it.

claude mcp list

surrealdb should be listed as connected.

Show me the SurrealDB instances in my organisation, and tell me which of them are paused.

Claude lists your organisations, picks the one you meant, and reports each instance with its state.

claude mcp remove surrealdb

Was this page helpful?