Skip to content

Commit 9681435

Browse files
authored
Add SurrealDB MCP server (#243)
Claude-Session: https://claude.ai/code/session_01S58U7phvDgphx6ZTXuWMJQ Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
1 parent e88b915 commit 9681435

1 file changed

Lines changed: 138 additions & 0 deletions

File tree

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
{
2+
"$schema": "../schemas/server-definition.schema.json",
3+
"id": "com.surrealdb-mcp-docker",
4+
"name": "SurrealDB (Docker)",
5+
"alias": "surrealdb",
6+
"description": "Connect to a SurrealDB instance or Surreal Cloud via Docker. Run SurrealQL queries, manage records, inspect namespaces and databases, and explore schemas through the official SurrealDB MCP server in an isolated container.",
7+
"logo": "https://avatars.githubusercontent.com/u/10982346?v=4",
8+
"schema_version": "2.1",
9+
"categories": [
10+
"database"
11+
],
12+
"tags": [
13+
"surrealdb",
14+
"database",
15+
"surrealql",
16+
"multi-model",
17+
"graph",
18+
"docker"
19+
],
20+
"transport": {
21+
"type": "stdio",
22+
"command": "docker",
23+
"args": [
24+
"run",
25+
"-i",
26+
"--rm",
27+
"-e",
28+
"SURREALDB_URL",
29+
"-e",
30+
"SURREALDB_NS",
31+
"-e",
32+
"SURREALDB_DB",
33+
"-e",
34+
"SURREALDB_USER",
35+
"-e",
36+
"SURREALDB_PASS",
37+
"-e",
38+
"SURREAL_MCP_CLOUD_ACCESS_TOKEN",
39+
"surrealdb/surrealmcp:latest",
40+
"start"
41+
],
42+
"env": {
43+
"SURREALDB_URL": "${input:SURREALDB_URL}",
44+
"SURREALDB_NS": "${input:SURREALDB_NS}",
45+
"SURREALDB_DB": "${input:SURREALDB_DB}",
46+
"SURREALDB_USER": "${input:SURREALDB_USER}",
47+
"SURREALDB_PASS": "${input:SURREALDB_PASS}",
48+
"SURREAL_MCP_CLOUD_ACCESS_TOKEN": "${input:SURREAL_MCP_CLOUD_ACCESS_TOKEN}"
49+
},
50+
"metadata": {
51+
"inputs": [
52+
{
53+
"id": "SURREALDB_URL",
54+
"label": "SurrealDB Endpoint URL",
55+
"description": "SurrealDB connection endpoint. Use host.docker.internal instead of localhost to reach a SurrealDB instance running on the host from inside Docker (e.g., ws://host.docker.internal:8000/rpc).",
56+
"type": "text",
57+
"required": false,
58+
"secret": false,
59+
"placeholder": "ws://host.docker.internal:8000/rpc"
60+
},
61+
{
62+
"id": "SURREALDB_NS",
63+
"label": "Namespace",
64+
"description": "The SurrealDB namespace to connect to.",
65+
"type": "text",
66+
"required": false,
67+
"secret": false,
68+
"placeholder": "mynamespace"
69+
},
70+
{
71+
"id": "SURREALDB_DB",
72+
"label": "Database",
73+
"description": "The SurrealDB database to connect to.",
74+
"type": "text",
75+
"required": false,
76+
"secret": false,
77+
"placeholder": "mydatabase"
78+
},
79+
{
80+
"id": "SURREALDB_USER",
81+
"label": "Username",
82+
"description": "The SurrealDB username to authenticate with.",
83+
"type": "text",
84+
"required": false,
85+
"secret": false,
86+
"placeholder": "root"
87+
},
88+
{
89+
"id": "SURREALDB_PASS",
90+
"label": "Password",
91+
"description": "The SurrealDB password to authenticate with.",
92+
"type": "text",
93+
"required": false,
94+
"secret": true,
95+
"placeholder": "********"
96+
},
97+
{
98+
"id": "SURREAL_MCP_CLOUD_ACCESS_TOKEN",
99+
"label": "Surreal Cloud Access Token",
100+
"description": "Surreal Cloud access token, used instead of username/password to connect to a Surreal Cloud instance. Leave empty for a self-hosted SurrealDB instance.",
101+
"type": "text",
102+
"required": false,
103+
"secret": true,
104+
"placeholder": "********",
105+
"obtain": {
106+
"url": "https://surrealdb.com/cloud",
107+
"instructions": "1. Sign in to Surreal Cloud\n2. Open your instance settings\n3. Generate or copy an access token\n4. Paste it here",
108+
"button_label": "Open Surreal Cloud"
109+
}
110+
}
111+
]
112+
}
113+
},
114+
"auth": {
115+
"type": "optional_api_key",
116+
"instructions": "Provide endpoint, namespace, database and username/password for a self-hosted SurrealDB instance, or a Surreal Cloud access token for Surreal Cloud. All connection values are optional and can also be supplied per-session through the MCP connection tools."
117+
},
118+
"contributor": {
119+
"name": "SurrealDB",
120+
"github": "surrealdb",
121+
"url": "https://surrealdb.com"
122+
},
123+
"links": {
124+
"repository": "https://github.com/surrealdb/surrealmcp",
125+
"homepage": "https://surrealdb.com",
126+
"documentation": "https://surrealdb.com/docs/mcp"
127+
},
128+
"platforms": [
129+
"all"
130+
],
131+
"capabilities": {
132+
"tools": true,
133+
"resources": true,
134+
"prompts": true,
135+
"read_only_mode": false
136+
},
137+
"changelog_url": "https://github.com/surrealdb/surrealmcp/releases"
138+
}

0 commit comments

Comments
 (0)