[{"_1":2,"_259":-5,"_260":-5},"loaderData",{"_3":4,"_22":23,"_24":25,"_214":215},"root",{"_5":6,"_7":8},"toasts",[],"visitor",{"_9":10,"_11":12},"viewportWidth",1280,"visitorSession",{"_13":14,"_16":17,"_18":-5,"_19":20,"_21":-5},"attributes",[15],"BOT","id",6963817,"membership","referenceId","0197053f-4517-73dc-9f09-6c85564c72eb","userAccount","routes/_public/_layout",{},"routes/_public/mcp/servers/~namespace/~slug/_pages/_layout",{"_26":27,"_68":-5,"_69":28,"_29":70,"_132":133,"_213":112},"availableLocales",[28,40,47,54,61],{"_29":30,"_33":37,"_38":39},"mcpServer",{"_31":32,"_33":34,"_35":36},"description","Connect your AI models to your favorite SurrealDB database, and let the LLMs do all your work for you.","name","SurrealDB MCP Server","readme","# SurrealDB MCP Server\n\n

\n $\"SurrealDB$ \n

\n\n

\n $\"npm$ \n $\"License:$ \n $\"Node.js$ \n $\"MCP$ \n

\n\nA Model Context Protocol (MCP) server that provides a standardized interface for AI assistants to interact with a [SurrealDB](https://surrealdb.com/) database. This server enables AI systems to query and manipulate data within a configured SurrealDB instance.\n\n> **Note for AI Assistants:** If you are an AI assistant (like Claude, Cline, Copilot, etc.) reading this documentation, please refer to the [llms-install.md](llms-install.md) file for detailed instructions specifically designed for you to help users install and configure this MCP server.\n\n## Installation Guide\n\n### Which AI assistant are you using?\n\n- **📝 Using Cline VS Code Extension?** → [Go to Cline Installation](#cline-installation)\n- **🖥️ Using Claude Desktop App?** → [Go to Claude Installation](#claude-installation)\n- **🤖 Using GitHub Copilot in VS Code?** → [Go to Copilot Installation](#copilot-installation)\n- **🦘 Using Roo Code in VS Code?** → [Go to Roo Code Installation](#roo-code-installation)\n- **🌊 Using Windsurf?** → [Go to Windsurf Installation](#windsurf-installation)\n- **⚡ Using Cursor?** → [Go to Cursor Installation](#cursor-installation)\n- **🔄 Using [n8n](https://n8n.io/)?** → [Go to n8n Integration](#integration-with-n8n)\n\n## Key Terms\n\n- **MCP Server**: A server that implements the Model Context Protocol, allowing AI assistants to access external tools and resources\n- **MCP Host**: The application (like VS Code with Cline or Claude Desktop) that connects to MCP servers\n- **[SurrealDB](https://surrealdb.com/)**: A scalable, distributed, document-graph database with real-time capabilities\n\n## Available Tools\n\nThe server exposes the following tools for interacting with SurrealDB:\n\n- `query`: Execute a raw SurrealQL query.\n- `select`: Select records from a table (all or by specific ID).\n- `create`: Create a single new record in a table.\n- `update`: Update a specific record, replacing its content.\n- `delete`: Delete a specific record by ID.\n- `merge`: Merge data into a specific record (partial update).\n- `patch`: Apply JSON Patch operations to a specific record.\n- `upsert`: Create a record if it doesn't exist, or update it if it does.\n- `insert`: Insert multiple records into a table.\n- `insertRelation`: Create a graph relation (edge) between two records.\n\n*(Refer to the MCP host's tool listing for detailed input schemas.)*\n\n## 📝 Cline Installation\n\n### One-Click Installation for Cline VS Code Extension\n\n1. **Install the package globally:**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **Add to Cline settings:**\n\n Edit the file at: `%APPDATA%\\Code\\User\\globalStorage\\saoudrizwan.claude-dev\\settings\\cline_mcp_settings.json`\n \n Add the following configuration:\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > **Important:** Replace `YOUR_USERNAME` with your actual Windows username in the path.\n\n3. **Restart VS Code**\n\n4. **Verify Installation:**\n - Open Cline in VS Code\n - Ask Cline to \"list available MCP servers\"\n - You should see \"surrealdb\" in the list\n\n## 🖥️ Claude Installation\n\n### Installation for Claude Desktop App\n\n1. **Configure Claude Desktop to use the server:**\n \n Edit the Claude Desktop App's MCP settings file:\n - Windows: `%APPDATA%\\Claude\\claude_desktop_config.json`\n - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`\n - Linux: `~/.config/Claude/claude_desktop_config.json`\n\n Add the following configuration:\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > **Note:** Using the `npx` command as shown above means the MCP client will automatically download and run the package from npm when needed. No manual installation is required.\n\n2. **Restart Claude Desktop App**\n\n3. **Verify Installation:**\n - Ask Claude to \"list available MCP servers\"\n - You should see \"surrealdb\" in the list\n\n## 🤖 Copilot Installation\n\n### Installation for GitHub Copilot in VS Code\n\n1. **Create a workspace configuration file:**\n \n Create a file at: `.vscode/mcp.json` in your workspace\n \n Add the following configuration:\n\n ```json\n {\n \"inputs\": [\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-url\",\n \"description\": \"SurrealDB URL\",\n \"default\": \"ws://localhost:8000\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-ns\",\n \"description\": \"SurrealDB Namespace\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-db\",\n \"description\": \"SurrealDB Database\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-user\",\n \"description\": \"SurrealDB Username\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-pass\",\n \"description\": \"SurrealDB Password\",\n \"password\": true\n }\n ],\n \"servers\": {\n \"surrealdb\": {\n \"type\": \"stdio\",\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"${input:surrealdb-url}\",\n \"SURREALDB_NS\": \"${input:surrealdb-ns}\",\n \"SURREALDB_DB\": \"${input:surrealdb-db}\",\n \"SURREALDB_USER\": \"${input:surrealdb-user}\",\n \"SURREALDB_PASS\": \"${input:surrealdb-pass}\"\n }\n }\n }\n }\n ```\n\n > **Note:** This configuration uses VS Code's input variables to securely prompt for and store your SurrealDB credentials.\n\n2. **Verify Installation:**\n - Open GitHub Copilot Chat in VS Code\n - Select \"Agent\" mode from the dropdown\n - Click the \"Tools\" button to see available tools\n - You should see SurrealDB tools in the list\n\n## 🦘 Roo Code Installation\n\n### Installation for Roo Code in VS Code\n\n1. **Access MCP Settings:**\n \n Click the MCP icon in the top navigation of the Roo Code pane, then select \"Edit MCP Settings\" to open the configuration file.\n\n2. **Add the SurrealDB MCP Server configuration:**\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > **Important:** Replace `YOUR_USERNAME` with your actual Windows username in the path.\n\n3. **Restart VS Code**\n\n4. **Verify Installation:**\n - Open Roo Code in VS Code\n - Click the MCP icon to see available servers\n - You should see \"surrealdb\" in the list\n\n## 🌊 Windsurf Installation\n\n### Installation for Windsurf\n\n1. **Install the package globally:**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **Configure Windsurf:**\n \n - Open Windsurf on your system\n - Navigate to the Settings page\n - Go to the Cascade tab\n - Find the Model Context Protocol (MCP) Servers section\n - Click on \"View raw config\" to open the configuration file (typically at `~/.codeium/windsurf/mcp_config.json`)\n\n3. **Add the SurrealDB MCP Server configuration:**\n\n ```json\n {\n \"servers\": [\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ]\n }\n ```\n\n > **Note:** Replace `/path/to/global/node_modules` with the actual path to your global node_modules directory.\n\n4. **Restart Windsurf**\n\n5. **Verify Installation:**\n - Open Cascade in Windsurf\n - You should see SurrealDB tools available in the tools list\n\n## ⚡ Cursor Installation\n\n### Installation for Cursor\n\n1. **Install the package globally:**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **Configure Cursor:**\n \n - Open Cursor\n - Go to Settings > Cursor Settings\n - Find the MCP Servers option and enable it\n - Click on \"Add New MCP Server\"\n\n3. **Add the SurrealDB MCP Server configuration:**\n\n ```json\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ```\n\n > **Note:** Replace `/path/to/global/node_modules` with the actual path to your global node_modules directory.\n\n4. **Restart Cursor**\n\n5. **Verify Installation:**\n - Open Cursor Chat\n - You should see SurrealDB tools available in the tools list\n\n## Required Environment Variables\n\nThis server requires the following environment variables to connect to your SurrealDB instance:\n\n- `SURREALDB_URL`: The WebSocket endpoint of your SurrealDB instance (e.g., `ws://localhost:8000` or `wss://cloud.surrealdb.com`).\n- `SURREALDB_NS`: The target Namespace.\n- `SURREALDB_DB`: The target Database.\n- `SURREALDB_USER`: The username for authentication (Root, NS, DB, or Scope user).\n- `SURREALDB_PASS`: The password for the specified user.\n\n## Troubleshooting\n\n### Common Issues\n\n#### \"Cannot find module\" Error\n\nIf you see an error like \"Cannot find module 'surrealdb-mcp-server'\", try:\n\n1. Verify the global installation: `npm list -g surrealdb-mcp-server`\n2. Check the path in your configuration matches the actual installation path\n3. Try reinstalling: `npm install -g surrealdb-mcp-server`\n\n#### Connection Errors\n\nIf you see \"Failed to connect to SurrealDB\":\n\n1. Verify SurrealDB is running: `surreal start --log debug`\n2. Check your connection URL, namespace, database, and credentials\n3. Ensure your SurrealDB instance is accessible from the path specified\n\n#### Cline-Specific Issues\n\nIf the npx approach doesn't work with Cline:\n\n1. Always use the global installation method for Cline\n2. Specify the full path to node.exe and the installed package\n3. Make sure to replace YOUR_USERNAME with your actual Windows username\n\n## Advanced Configuration\n\n### Using a Local Build\n\nIf you've cloned the repository or want to use a local build, you can use this configuration:\n\n```json\n{\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"node\",\n \"args\": [\"/path/to/your/surrealdb-mcp-server/build/index.js\"],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n}\n```\n\n- Replace `/path/to/your/surrealdb-mcp-server` with the actual path where you cloned the repository\n- Replace the environment variable values with your actual SurrealDB connection details\n\n## Development\n\nIf you want to contribute to the development of this MCP server, follow these steps:\n\n### Local Development Setup\n\n1. **Clone the repository:**\n ```bash\n git clone https://github.com/nsxdavid/surrealdb-mcp-server.git\n cd surrealdb-mcp-server\n ```\n\n2. **Install dependencies:**\n ```bash\n npm install\n ```\n\n3. **Build the project:**\n ```bash\n npm run build\n ```\n\n### Running Locally\n\n```bash\n# Ensure required SURREALDB_* environment variables are set\nnpm run dev # (Note: dev script uses ts-node to run TypeScript directly)\n# Or run the built version:\nnpm start\n```\n\n### Testing\n\n```bash\nnpm test # (Note: Tests need to be implemented)\n```\n\n### Contributing\n\nContributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\n## Integration with n8n\n\nYou can integrate this SurrealDB MCP Server with [n8n](https://n8n.io/) using the [n8n-nodes-mcp](https://github.com/nerding-io/n8n-nodes-mcp) community node.\n\n**NOTE: Currently only the [self-hosted (Docker) version of n8n](https://docs.n8n.io/hosting/installation/docker/) supports community nodes. There is no option for MCP Servers in the n8n cloud version (yet?).**\n\n### Installation\n\n1. **Install the n8n-nodes-mcp package:**\n\n ```bash\n npm install n8n-nodes-mcp\n ```\n\n2. **Configure n8n to use the custom node:**\n\n Add the following to your n8n configuration:\n\n ```bash\n N8N_CUSTOM_EXTENSIONS=\"n8n-nodes-mcp\"\n ```\n\n3. **Configure the MCP node in n8n:**\n \n - Add the \"MCP\" node to your workflow\n - Configure it to connect to your SurrealDB MCP Server\n - Select the desired operation (query, select, create, etc.)\n - Configure the operation parameters\n\nFor more details, visit the [n8n-nodes-mcp GitHub repository](https://github.com/nerding-io/n8n-nodes-mcp).\n\n## License\n\nMIT\n","English","tag","en-US",{"_29":41,"_33":45,"_38":46},{"_31":42,"_33":43,"_35":44},"Conecte sus modelos de IA a su base de datos SurrealDB favorita y deje que los LLM hagan todo el trabajo por usted.","Servidor MCP de SurrealDB","# Servidor MCP de SurrealDB\n\nUn servidor de Protocolo de Contexto de Modelo (MCP) que proporciona una interfaz estandarizada para que los asistentes de IA interactúen con una base de datos [de SurrealDB](https://surrealdb.com/) . Este servidor permite a los sistemas de IA consultar y manipular datos dentro de una instancia configurada de SurrealDB.\n\n> **Nota para asistentes de IA:** si usted es un asistente de IA (como Claude, Cline, Copilot, etc.) y está leyendo esta documentación, consulte el archivo [llms-install.md](llms-install.md) para obtener instrucciones detalladas diseñadas específicamente para usted, para ayudar a los usuarios a instalar y configurar este servidor MCP.\n\n## Guía de instalación\n\n### ¿Qué asistente de IA estás utilizando?\n\n* **¿Usas la extensión Cline de VS Code?** → [Ir a la instalación de Cline](#cline-installation)\n* **¿Usas la app de escritorio de Claude?** → [Ir a la instalación de Claude](#claude-installation)\n* **¿Usas GitHub Copilot en VS Code?** → [Ir a la instalación de Copilot](#copilot-installation)\n* **¿Usas Roo Code en VS Code?** → [Ir a la instalación de Roo Code](#roo-code-installation)\n* **¿Usas Windsurf?** → [Ir a Instalación de Windsurf](#windsurf-installation)\n* **⚡ ¿Usas Cursor?** → [Ir a Instalación de Cursor](#cursor-installation)\n* **¿Usas [n8n](https://n8n.io/) ?** → [Ir a la integración de n8n](#integration-with-n8n)\n\n## Términos clave\n\n* **Servidor MCP** : un servidor que implementa el Protocolo de Contexto de Modelo, lo que permite a los asistentes de IA acceder a herramientas y recursos externos.\n* **Host MCP** : la aplicación (como VS Code con Cline o Claude Desktop) que se conecta a los servidores MCP\n* **[SurrealDB](https://surrealdb.com/)** : una base de datos de gráficos de documentos, escalable y distribuida, con capacidades en tiempo real\n\n## Herramientas disponibles\n\nEl servidor expone las siguientes herramientas para interactuar con SurrealDB:\n\n* `query` : ejecuta una consulta SurrealQL sin procesar.\n* `select` : selecciona registros de una tabla (todos o por ID específico).\n* `create` : crea un único registro nuevo en una tabla.\n* `update` : Actualiza un registro específico, reemplazando su contenido.\n* `delete` : elimina un registro específico por ID.\n* `merge` : fusionar datos en un registro específico (actualización parcial).\n* `patch` : aplicar operaciones de parche JSON a un registro específico.\n* `upsert` : crea un registro si no existe o lo actualiza si existe.\n* `insert` : inserta varios registros en una tabla.\n* `insertRelation` : Crea una relación gráfica (borde) entre dos registros.\n\n*(Consulte la lista de herramientas del host MCP para obtener esquemas de entrada detallados).*\n\n## 📝 Instalación de Cline\n\n### Instalación con un solo clic de la extensión Cline VS Code\n\n1. **Instalar el paquete globalmente:**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **Agregar a la configuración de Cline:**\n\n Edite el archivo en: `%APPDATA%\\Code\\User\\globalStorage\\saoudrizwan.claude-dev\\settings\\cline_mcp_settings.json`\n\n Agregue la siguiente configuración:\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > **Importante:** reemplace `YOUR_USERNAME` con su nombre de usuario real de Windows en la ruta.\n\n3. **Reiniciar VS Code**\n\n4. **Verificar la instalación:**\n\n * Abrir Cline en VS Code\n * Pídele a Cline que \"enumere los servidores MCP disponibles\"\n * Deberías ver \"surrealdb\" en la lista\n\n## 🖥️ Instalación de Claude\n\n### Instalación de la aplicación de escritorio Claude\n\n1. **Configurar Claude Desktop para utilizar el servidor:**\n\n Edite el archivo de configuración MCP de la aplicación de escritorio Claude:\n\n * Ventanas: `%APPDATA%\\Claude\\claude_desktop_config.json`\n * macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`\n * Linux: `~/.config/Claude/claude_desktop_config.json`\n\n Agregue la siguiente configuración:\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > **Nota:** Usar el comando `npx` como se muestra arriba significa que el cliente MCP descargará y ejecutará automáticamente el paquete desde npm cuando sea necesario. No se requiere instalación manual.\n\n2. **Reiniciar la aplicación de escritorio Claude**\n\n3. **Verificar la instalación:**\n\n * Pídele a Claude que \"enumere los servidores MCP disponibles\"\n * Deberías ver \"surrealdb\" en la lista\n\n## 🤖 Instalación del copiloto\n\n### Instalación de GitHub Copilot en VS Code\n\n1. **Crear un archivo de configuración del espacio de trabajo:**\n\n Crea un archivo en: `.vscode/mcp.json` en tu espacio de trabajo\n\n Agregue la siguiente configuración:\n\n ```json\n {\n \"inputs\": [\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-url\",\n \"description\": \"SurrealDB URL\",\n \"default\": \"ws://localhost:8000\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-ns\",\n \"description\": \"SurrealDB Namespace\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-db\",\n \"description\": \"SurrealDB Database\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-user\",\n \"description\": \"SurrealDB Username\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-pass\",\n \"description\": \"SurrealDB Password\",\n \"password\": true\n }\n ],\n \"servers\": {\n \"surrealdb\": {\n \"type\": \"stdio\",\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"${input:surrealdb-url}\",\n \"SURREALDB_NS\": \"${input:surrealdb-ns}\",\n \"SURREALDB_DB\": \"${input:surrealdb-db}\",\n \"SURREALDB_USER\": \"${input:surrealdb-user}\",\n \"SURREALDB_PASS\": \"${input:surrealdb-pass}\"\n }\n }\n }\n }\n ```\n\n > **Nota:** Esta configuración utiliza las variables de entrada de VS Code para solicitar y almacenar de forma segura sus credenciales de SurrealDB.\n\n2. **Verificar la instalación:**\n\n * Abrir GitHub Copilot Chat en VS Code\n * Seleccione el modo \"Agente\" en el menú desplegable.\n * Haga clic en el botón \"Herramientas\" para ver las herramientas disponibles.\n * Deberías ver las herramientas de SurrealDB en la lista\n\n## 🦘 Instalación del código Roo\n\n### Instalación de Roo Code en VS Code\n\n1. **Acceder a la configuración de MCP:**\n\n Haga clic en el ícono MCP en la navegación superior del panel Código Roo, luego seleccione \"Editar configuración de MCP\" para abrir el archivo de configuración.\n\n2. **Agregue la configuración del servidor MCP de SurrealDB:**\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > **Importante:** reemplace `YOUR_USERNAME` con su nombre de usuario real de Windows en la ruta.\n\n3. **Reiniciar VS Code**\n\n4. **Verificar la instalación:**\n\n * Abrir Roo Code en VS Code\n * Haga clic en el icono de MCP para ver los servidores disponibles\n * Deberías ver \"surrealdb\" en la lista\n\n## 🌊 Instalación de Windsurf\n\n### Instalación para Windsurf\n\n1. **Instalar el paquete globalmente:**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **Configurar Windsurf:**\n\n * Abra Windsurf en su sistema\n * Vaya a la página de Configuración\n * Vaya a la pestaña Cascada\n * Encuentre la sección Servidores del Protocolo de Contexto de Modelo (MCP)\n * Haga clic en \"Ver configuración sin procesar\" para abrir el archivo de configuración (normalmente en `~/.codeium/windsurf/mcp_config.json` )\n\n3. **Agregue la configuración del servidor MCP de SurrealDB:**\n\n ```json\n {\n \"servers\": [\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ]\n }\n ```\n\n > **Nota:** Reemplace `/path/to/global/node_modules` con la ruta real a su directorio global node\\_modules.\n\n4. **Reiniciar Windsurf**\n\n5. **Verificar la instalación:**\n\n * Cascada abierta en Windsurf\n * Debería ver las herramientas de SurrealDB disponibles en la lista de herramientas\n\n## ⚡ Instalación del cursor\n\n### Instalación para Cursor\n\n1. **Instalar el paquete globalmente:**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **Configurar cursor:**\n\n * Cursor abierto\n * Vaya a Configuración > Configuración del cursor\n * Busque la opción Servidores MCP y habilítela\n * Haga clic en \"Agregar nuevo servidor MCP\"\n\n3. **Agregue la configuración del servidor MCP de SurrealDB:**\n\n ```json\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ```\n\n > **Nota:** Reemplace `/path/to/global/node_modules` con la ruta real a su directorio global node\\_modules.\n\n4. **Reiniciar cursor**\n\n5. **Verificar la instalación:**\n\n * Abrir el chat del cursor\n * Debería ver las herramientas de SurrealDB disponibles en la lista de herramientas\n\n## Variables de entorno requeridas\n\nEste servidor requiere las siguientes variables de entorno para conectarse a su instancia de SurrealDB:\n\n* `SURREALDB_URL` : el punto final WebSocket de su instancia de SurrealDB (por ejemplo, `ws://localhost:8000` o `wss://cloud.surrealdb.com` ).\n* `SURREALDB_NS` : El espacio de nombres de destino.\n* `SURREALDB_DB` : La base de datos de destino.\n* `SURREALDB_USER` : El nombre de usuario para la autenticación (usuario raíz, NS, DB o Scope).\n* `SURREALDB_PASS` : La contraseña para el usuario especificado.\n\n## Solución de problemas\n\n### Problemas comunes\n\n#### Error \"No se puede encontrar el módulo\"\n\nSi ve un error como \"No se puede encontrar el módulo 'surrealdb-mcp-server'\", intente:\n\n1. Verifique la instalación global: `npm list -g surrealdb-mcp-server`\n2. Verifique que la ruta en su configuración coincida con la ruta de instalación real\n3. Intente reinstalar: `npm install -g surrealdb-mcp-server`\n\n#### Errores de conexión\n\nSi ve \"Error al conectarse a SurrealDB\":\n\n1. Verifique que SurrealDB se esté ejecutando: `surreal start --log debug`\n2. Verifique su URL de conexión, espacio de nombres, base de datos y credenciales\n3. Asegúrese de que su instancia de SurrealDB sea accesible desde la ruta especificada\n\n#### Problemas específicos de Cline\n\nSi el enfoque npx no funciona con Cline:\n\n1. Utilice siempre el método de instalación global para Cline\n2. Especifique la ruta completa a node.exe y el paquete instalado\n3. Asegúrese de reemplazar YOUR\\_USERNAME con su nombre de usuario real de Windows\n\n## Configuración avanzada\n\n### Usando una compilación local\n\nSi ha clonado el repositorio o desea utilizar una compilación local, puede usar esta configuración:\n\n```json\n{\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"node\",\n \"args\": [\"/path/to/your/surrealdb-mcp-server/build/index.js\"],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n}\n```\n\n* Reemplace `/path/to/your/surrealdb-mcp-server` con la ruta real donde clonó el repositorio\n* Reemplace los valores de las variables de entorno con los detalles de conexión reales de SurrealDB\n\n## Desarrollo\n\nSi desea contribuir al desarrollo de este servidor MCP, siga estos pasos:\n\n### Configuración de desarrollo local\n\n1. **Clonar el repositorio:**\n\n ```bash\n git clone https://github.com/nsxdavid/surrealdb-mcp-server.git\n cd surrealdb-mcp-server\n ```\n\n2. **Instalar dependencias:**\n\n ```bash\n npm install\n ```\n\n3. **Construir el proyecto:**\n\n ```bash\n npm run build\n ```\n\n### Ejecutando localmente\n\n```bash\n# Ensure required SURREALDB_* environment variables are set\nnpm run dev # (Note: dev script uses ts-node to run TypeScript directly)\n# Or run the built version:\nnpm start\n```\n\n### Pruebas\n\n```bash\nnpm test # (Note: Tests need to be implemented)\n```\n\n### Contribuyendo\n\n¡Agradecemos sus contribuciones! Consulte las normas [en CONTRIBUTING.md](CONTRIBUTING.md) .\n\n## Integración con n8n\n\nPuede integrar este servidor MCP de SurrealDB con [n8n](https://n8n.io/) utilizando el nodo comunitario [n8n-nodes-mcp](https://github.com/nerding-io/n8n-nodes-mcp) .\n\n**NOTA: Actualmente, solo la [versión autoalojada (Docker) de n8n](https://docs.n8n.io/hosting/installation/docker/) admite nodos comunitarios. No existe la opción de servidores MCP en la versión en la nube de n8n (¿aún?).**\n\n### Instalación\n\n1. **Instale el paquete n8n-nodes-mcp:**\n\n ```bash\n npm install n8n-nodes-mcp\n ```\n\n2. **Configure n8n para utilizar el nodo personalizado:**\n\n Agregue lo siguiente a su configuración n8n:\n\n ```bash\n N8N_CUSTOM_EXTENSIONS=\"n8n-nodes-mcp\"\n ```\n\n3. **Configurar el nodo MCP en n8n:**\n\n * Agregue el nodo \"MCP\" a su flujo de trabajo\n * Configúrelo para conectarse a su servidor MCP de SurrealDB\n * Seleccione la operación deseada (consulta, selección, crear, etc.)\n * Configurar los parámetros de operación\n\nPara obtener más detalles, visita el [repositorio de GitHub n8n-nodes-mcp](https://github.com/nerding-io/n8n-nodes-mcp) .\n\n## Licencia\n\nInstituto Tecnológico de Massachusetts (MIT)","Spanish","es-ES",{"_29":48,"_33":52,"_38":53},{"_31":49,"_33":50,"_35":51},"AI モデルをお気に入りの SurrealDB データベースに接続し、LLM にすべての作業を任せましょう。","SurrealDB MCP サーバー","# SurrealDB MCP サーバー\n\nAIアシスタントが[SurrealDB](https://surrealdb.com/)データベースと対話するための標準化されたインターフェースを提供する、モデルコンテキストプロトコル（MCP）サーバー。このサーバーにより、AIシステムは設定されたSurrealDBインスタンス内のデータをクエリおよび操作できるようになります。\n\n> \\*\\*AI アシスタント向けの注意:\\*\\*このドキュメントを読んでいる AI アシスタント (Claude、Cline、Copilot など) の場合は、ユーザーがこの MCP サーバーをインストールして構成できるように特別に設計された詳細な手順については、 [llms-install.md](llms-install.md)ファイルを参照してください。\n\n## インストールガイド\n\n### どの AI アシスタントを使用していますか?\n\n* **📝 Cline VS Code拡張機能をお使いですか？** → [Clineのインストールへ](#cline-installation)\n* **🖥️ Claudeデスクトップアプリをお使いですか？** → [Claudeのインストールへ](#claude-installation)\n* **🤖 VS CodeでGitHub Copilotを使用していますか？** → [Copilotのインストールへ](#copilot-installation)\n* **🦘 VS Code で Roo Code を使用していますか?** → [Roo Code のインストールへ](#roo-code-installation)\n* **🌊 Windsurf をお使いですか？** → [Windsurf のインストールへ](#windsurf-installation)\n* **⚡ カーソルを使用していますか？** →[カーソルのインストールへ](#cursor-installation)\n* **🔄 [n8n](https://n8n.io/)をご利用ですか？** → [n8n 統合へ](#integration-with-n8n)\n\n## キーワード\n\n* **MCPサーバー**:モデルコンテキストプロトコルを実装し、AIアシスタントが外部ツールやリソースにアクセスできるようにするサーバー\n* **MCP ホスト**: MCP サーバーに接続するアプリケーション (Cline または Claude Desktop を使用した VS Code など)\n* **[SurrealDB](https://surrealdb.com/)** : リアルタイム機能を備えたスケーラブルな分散型ドキュメントグラフデータベース\n\n## 利用可能なツール\n\nサーバーは、SurrealDB と対話するための次のツールを公開します。\n\n* `query` : 生の SurrealQL クエリを実行します。\n* `select` : テーブルからレコードを選択します (すべてまたは特定の ID で)。\n* `create` : テーブルに 1 つの新しいレコードを作成します。\n* `update` : 特定のレコードを更新し、その内容を置き換えます。\n* `delete` : ID で特定のレコードを削除します。\n* `merge` : 特定のレコードにデータをマージします (部分更新)。\n* `patch` : 特定のレコードに JSON Patch 操作を適用します。\n* `upsert` : レコードが存在しない場合は作成し、存在する場合は更新します。\n* `insert` : 複数のレコードをテーブルに挿入します。\n* `insertRelation` : 2 つのレコード間にグラフ関係 (エッジ) を作成します。\n\n*(詳細な入力スキーマについては、MCP ホストのツールリストを参照してください。)*\n\n## 📝 クライン設置\n\n### Cline VS Code拡張機能のワンクリックインストール\n\n1. **パッケージをグローバルにインストールします。**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **Cline設定に追加:**\n\n 次のファイルを編集します: `%APPDATA%\\Code\\User\\globalStorage\\saoudrizwan.claude-dev\\settings\\cline_mcp_settings.json`\n\n 次の構成を追加します。\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > \\*\\*重要:\\*\\*パス内の`YOUR_USERNAME`実際の Windows ユーザー名に置き換えてください。\n\n3. **VS Codeを再起動する**\n\n4. **インストールの確認:**\n\n * VS CodeでClineを開く\n * Cline に「利用可能な MCP サーバーを一覧表示する」ように依頼します。\n * リストに「surrealdb」が表示されるはずです\n\n## 🖥️ クロード・インスタレーション\n\n### Claudeデスクトップアプリのインストール\n\n1. **サーバーを使用するように Claude Desktop を構成します。**\n\n Claude デスクトップアプリの MCP 設定ファイルを編集します。\n\n * Windows: `%APPDATA%\\Claude\\claude_desktop_config.json`\n * macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`\n * Linux: `~/.config/Claude/claude_desktop_config.json`\n\n 次の構成を追加します。\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > \\*\\*注:\\*\\*上記のように`npx`コマンドを使用すると、MCPクライアントは必要に応じてnpmからパッケージを自動的にダウンロードして実行します。手動でインストールする必要はありません。\n\n2. **Claudeデスクトップアプリを再起動します**\n\n3. **インストールの確認:**\n\n * クロードに「利用可能な MCP サーバーをリストする」ように依頼します。\n * リストに「surrealdb」が表示されるはずです\n\n## 🤖 副操縦士のインストール\n\n### VS Code での GitHub Copilot のインストール\n\n1. **ワークスペース構成ファイルを作成します。**\n\n ワークスペースに`.vscode/mcp.json`というファイルを作成します。\n\n 次の構成を追加します。\n\n ```json\n {\n \"inputs\": [\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-url\",\n \"description\": \"SurrealDB URL\",\n \"default\": \"ws://localhost:8000\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-ns\",\n \"description\": \"SurrealDB Namespace\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-db\",\n \"description\": \"SurrealDB Database\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-user\",\n \"description\": \"SurrealDB Username\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-pass\",\n \"description\": \"SurrealDB Password\",\n \"password\": true\n }\n ],\n \"servers\": {\n \"surrealdb\": {\n \"type\": \"stdio\",\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"${input:surrealdb-url}\",\n \"SURREALDB_NS\": \"${input:surrealdb-ns}\",\n \"SURREALDB_DB\": \"${input:surrealdb-db}\",\n \"SURREALDB_USER\": \"${input:surrealdb-user}\",\n \"SURREALDB_PASS\": \"${input:surrealdb-pass}\"\n }\n }\n }\n }\n ```\n\n > \\*\\*注:\\*\\*この構成では、VS Code の入力変数を使用して、SurrealDB 資格情報を安全に要求し、保存します。\n\n2. **インストールの確認:**\n\n * VS CodeでGitHub Copilotチャットを開く\n * ドロップダウンから「エージェント」モードを選択します\n * 利用可能なツールを表示するには、「ツール」ボタンをクリックします\n * リストにSurrealDBツールが表示されるはずです\n\n## 🦘 Roo Codeのインストール\n\n### VS Code での Roo Code のインストール\n\n1. **MCP 設定にアクセスします。**\n\n Roo Code ペインの上部ナビゲーションにある MCP アイコンをクリックし、「MCP 設定の編集」を選択して構成ファイルを開きます。\n\n2. **SurrealDB MCP サーバー構成を追加します。**\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > \\*\\*重要:\\*\\*パス内の`YOUR_USERNAME`実際の Windows ユーザー名に置き換えてください。\n\n3. **VS Codeを再起動する**\n\n4. **インストールの確認:**\n\n * VS CodeでRoo Codeを開く\n * 利用可能なサーバーを確認するには、MCPアイコンをクリックしてください。\n * リストに「surrealdb」が表示されるはずです\n\n## 🌊 ウィンドサーフィンの設置\n\n### ウィンドサーフィン用インスタレーション\n\n1. **パッケージをグローバルにインストールします。**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **Windsurf の設定:**\n\n * システムでWindsurfを開きます\n * 設定ページに移動します\n * カスケードタブへ移動\n * モデルコンテキストプロトコル（MCP）サーバーセクションを見つけます\n * 「生の構成を表示」をクリックして構成ファイルを開きます（通常は`~/.codeium/windsurf/mcp_config.json`にあります）。\n\n3. **SurrealDB MCP サーバー構成を追加します。**\n\n ```json\n {\n \"servers\": [\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ]\n }\n ```\n\n > **注:** `/path/to/global/node_modules`グローバル node\\_modules ディレクトリへの実際のパスに置き換えます。\n\n4. **ウィンドサーフィンを再開**\n\n5. **インストールの確認:**\n\n * ウィンドサーフィンのオープンカスケード\n * ツールリストにSurrealDBツールが表示されるはずです。\n\n## ⚡ カーソルのインストール\n\n### カーソルのインストール\n\n1. **パッケージをグローバルにインストールします。**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **カーソルの設定:**\n\n * オープンカーソル\n * 設定 > カーソル設定に移動します\n * MCPサーバーオプションを見つけて有効にします\n * 「新しいMCPサーバーを追加」をクリックします\n\n3. **SurrealDB MCP サーバー構成を追加します。**\n\n ```json\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ```\n\n > **注:** `/path/to/global/node_modules`グローバル node\\_modules ディレクトリへの実際のパスに置き換えます。\n\n4. **カーソルを再開**\n\n5. **インストールの確認:**\n\n * カーソルチャットを開く\n * ツールリストにSurrealDBツールが表示されるはずです。\n\n## 必要な環境変数\n\nこのサーバーは、SurrealDB インスタンスに接続するために次の環境変数を必要とします。\n\n* `SURREALDB_URL` : SurrealDB インスタンスの WebSocket エンドポイント (例: `ws://localhost:8000`または`wss://cloud.surrealdb.com` )。\n* `SURREALDB_NS` : ターゲット名前空間。\n* `SURREALDB_DB` : ターゲットデータベース。\n* `SURREALDB_USER` : 認証用のユーザー名 (ルート、NS、DB、またはスコープユーザー)。\n* `SURREALDB_PASS` : 指定されたユーザーのパスワード。\n\n## トラブルシューティング\n\n### よくある問題\n\n#### 「モジュールが見つかりません」エラー\n\n「モジュール 'surrealdb-mcp-server' が見つかりません」のようなエラーが表示された場合は、次の操作を試してください。\n\n1. グローバルインストールを確認します: `npm list -g surrealdb-mcp-server`\n2. 設定内のパスが実際のインストールパスと一致していることを確認します\n3. 再インストールを試してください: `npm install -g surrealdb-mcp-server`\n\n#### 接続エラー\n\n「SurrealDB への接続に失敗しました」と表示された場合:\n\n1. SurrealDB が実行中であることを確認します: `surreal start --log debug`\n2. 接続URL、名前空間、データベース、資格情報を確認してください\n3. SurrealDBインスタンスが指定されたパスからアクセスできることを確認してください\n\n#### クライン特有の問題\n\nnpx アプローチが Cline で機能しない場合は、次の手順に従ってください。\n\n1. Clineには常にグローバルインストール方法を使用してください\n2. node.exeとインストールされたパッケージへのフルパスを指定します\n3. YOUR\\_USERNAMEを実際のWindowsユーザー名に置き換えてください。\n\n## 詳細設定\n\n### ローカルビルドの使用\n\nリポジトリをクローンした場合、またはローカルビルドを使用する場合は、次の構成を使用できます。\n\n```json\n{\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"node\",\n \"args\": [\"/path/to/your/surrealdb-mcp-server/build/index.js\"],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n}\n```\n\n* `/path/to/your/surrealdb-mcp-server`リポジトリをクローンした実際のパスに置き換えます。\n* 環境変数の値を実際の SurrealDB 接続の詳細に置き換えます。\n\n## 発達\n\nこの MCP サーバーの開発に貢献したい場合は、次の手順に従ってください。\n\n### ローカル開発のセットアップ\n\n1. **リポジトリをクローンします。**\n\n ```bash\n git clone https://github.com/nsxdavid/surrealdb-mcp-server.git\n cd surrealdb-mcp-server\n ```\n\n2. **依存関係をインストールします:**\n\n ```bash\n npm install\n ```\n\n3. **プロジェクトをビルドします。**\n\n ```bash\n npm run build\n ```\n\n### ローカルで実行\n\n```bash\n# Ensure required SURREALDB_* environment variables are set\nnpm run dev # (Note: dev script uses ts-node to run TypeScript directly)\n# Or run the built version:\nnpm start\n```\n\n### テスト\n\n```bash\nnpm test # (Note: Tests need to be implemented)\n```\n\n### 貢献\n\n貢献を歓迎します！ガイドラインについては[CONTRIBUTING.mdを](CONTRIBUTING.md)ご覧ください。\n\n## n8nとの統合\n\n[n8n-nodes-mcp](https://github.com/nerding-io/n8n-nodes-mcp)コミュニティノードを使用して、この SurrealDB MCP サーバーを[n8n](https://n8n.io/)と統合できます。\n\n**注：現在、コミュニティノードをサポートしているのは[、n8nのセルフホスト（Docker）版](https://docs.n8n.io/hosting/installation/docker/)のみです。n8nクラウド版には、MCPサーバーのオプションは（今のところ？）ありません。**\n\n### インストール\n\n1. **n8n-nodes-mcp パッケージをインストールします。**\n\n ```bash\n npm install n8n-nodes-mcp\n ```\n\n2. **カスタムノードを使用するように n8n を構成します。**\n\n n8n 構成に以下を追加します。\n\n ```bash\n N8N_CUSTOM_EXTENSIONS=\"n8n-nodes-mcp\"\n ```\n\n3. **n8n で MCP ノードを構成します。**\n\n * ワークフローに「MCP」ノードを追加します\n * SurrealDB MCPサーバーに接続するように設定します\n * 必要な操作 (クエリ、選択、作成など) を選択します。\n * 操作パラメータを設定する\n\n詳細については、 [n8n-nodes-mcp GitHub リポジトリ](https://github.com/nerding-io/n8n-nodes-mcp)をご覧ください。\n\n## ライセンス\n\nマサチューセッツ工科大学","Japanese","ja-JP",{"_29":55,"_33":59,"_38":60},{"_31":56,"_33":57,"_35":58},"AI 모델을 원하는 SurrealDB 데이터베이스에 연결하고 LLM이 모든 작업을 대신 처리하도록 하세요.","SurrealDB MCP 서버","# SurrealDB MCP 서버\n\nAI 어시스턴트가 [SurrealDB](https://surrealdb.com/) 데이터베이스와 상호 작용할 수 있도록 표준화된 인터페이스를 제공하는 모델 컨텍스트 프로토콜(MCP) 서버입니다. 이 서버를 통해 AI 시스템은 구성된 SurrealDB 인스턴스 내에서 데이터를 쿼리하고 조작할 수 있습니다.\n\n> **AI 보조원을 위한 참고 사항:** 클로드, 클라인, 코파일럿 등과 같은 AI 보조원이 이 문서를 읽고 있다면, 사용자가 이 MCP 서버를 설치하고 구성하는 데 도움이 되도록 특별히 고안된 자세한 지침이 있는 [llms-install.md](llms-install.md) 파일을 참조하세요.\n\n## 설치 가이드\n\n### 어떤 AI 비서를 사용하고 계신가요?\n\n* **📝 Cline VS Code 확장 프로그램을 사용하시나요?** → [Cline 설치 페이지로 이동](#cline-installation)\n* **🖥️ Claude 데스크톱 앱을 사용하시나요?** → [Claude 설치 페이지로 이동](#claude-installation)\n* **🤖 VS Code에서 GitHub Copilot을 사용하시나요?** → [Copilot 설치 페이지로 이동](#copilot-installation)\n* **🦘 VS Code에서 Roo Code를 사용하시나요?** → [Roo Code 설치로 이동](#roo-code-installation)\n* **🌊 Windsurf를 사용하시나요?** → [Windsurf 설치 페이지로 이동](#windsurf-installation)\n* **⚡ 커서를 사용하시나요?** → [커서 설치로 이동](#cursor-installation)\n* **🔄 [n8n을](https://n8n.io/) 사용하시나요?** → [n8n 통합 페이지로 이동](#integration-with-n8n)\n\n## 주요 용어\n\n* **MCP 서버** : AI 어시스턴트가 외부 도구 및 리소스에 액세스할 수 있도록 하는 모델 컨텍스트 프로토콜을 구현하는 서버\n* **MCP 호스트** : MCP 서버에 연결하는 애플리케이션(Cline 또는 Claude Desktop이 포함된 VS Code 등)\n* **[SurrealDB](https://surrealdb.com/)** : 실시간 기능을 갖춘 확장 가능한 분산 문서 그래프 데이터베이스\n\n## 사용 가능한 도구\n\n서버는 SurrealDB와 상호 작용하기 위해 다음과 같은 도구를 제공합니다.\n\n* `query` : 원시 SurrealQL 쿼리를 실행합니다.\n* `select` : 테이블에서 레코드를 선택합니다(전체 또는 특정 ID로).\n* `create` : 테이블에 단일 새 레코드를 만듭니다.\n* `update` : 특정 레코드를 업데이트하여 해당 내용을 바꿉니다.\n* `delete` : ID로 특정 레코드를 삭제합니다.\n* `merge` : 특정 레코드에 데이터를 병합합니다(부분 업데이트).\n* `patch` : 특정 레코드에 JSON 패치 작업을 적용합니다.\n* `upsert` : 레코드가 없으면 생성하고, 있으면 업데이트합니다.\n* `insert` : 테이블에 여러 개의 레코드를 삽입합니다.\n* `insertRelation` : 두 레코드 간의 그래프 관계(에지)를 생성합니다.\n\n*(자세한 입력 스키마는 MCP 호스트의 도구 목록을 참조하세요.)*\n\n## 📝 클라인 설치\n\n### Cline VS Code 확장 프로그램을 위한 원클릭 설치\n\n1. **패키지를 전역으로 설치합니다.**\n\n 지엑스피1\n\n2. **Cline 설정에 추가:**\n\n `%APPDATA%\\Code\\User\\globalStorage\\saoudrizwan.claude-dev\\settings\\cline_mcp_settings.json` 에서 파일을 편집하세요.\n\n 다음 구성을 추가합니다.\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > **중요:** 경로에서 `YOUR_USERNAME` 실제 Windows 사용자 이름으로 바꾸세요.\n\n3. **VS 코드 재시작**\n\n4. **설치 확인:**\n\n * VS Code에서 Cline 열기\n * Cline에게 \"사용 가능한 MCP 서버 나열\"을 요청하세요.\n * 목록에 \"surrealdb\"가 표시되어야 합니다.\n\n## 🖥️ 클로드 설치\n\n### Claude 데스크톱 앱 설치\n\n1. **Claude Desktop을 구성하여 서버를 사용합니다.**\n\n Claude Desktop App의 MCP 설정 파일을 편집합니다.\n\n * Windows: `%APPDATA%\\Claude\\claude_desktop_config.json`\n * macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`\n * 리눅스: `~/.config/Claude/claude_desktop_config.json`\n\n 다음 구성을 추가합니다.\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > **참고:** 위에 표시된 대로 `npx` 명령을 사용하면 MCP 클라이언트가 필요 시 npm에서 패키지를 자동으로 다운로드하여 실행합니다. 수동 설치는 필요하지 않습니다.\n\n2. **Claude 데스크톱 앱을 다시 시작하세요**\n\n3. **설치 확인:**\n\n * Claude에게 \"사용 가능한 MCP 서버 나열\"을 요청하세요.\n * 목록에 \"surrealdb\"가 표시되어야 합니다.\n\n## 🤖 Copilot 설치\n\n### VS Code에서 GitHub Copilot 설치\n\n1. **작업 공간 구성 파일을 만듭니다.**\n\n 작업 공간에서 `.vscode/mcp.json` 파일을 만듭니다.\n\n 다음 구성을 추가합니다.\n\n ```json\n {\n \"inputs\": [\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-url\",\n \"description\": \"SurrealDB URL\",\n \"default\": \"ws://localhost:8000\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-ns\",\n \"description\": \"SurrealDB Namespace\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-db\",\n \"description\": \"SurrealDB Database\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-user\",\n \"description\": \"SurrealDB Username\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-pass\",\n \"description\": \"SurrealDB Password\",\n \"password\": true\n }\n ],\n \"servers\": {\n \"surrealdb\": {\n \"type\": \"stdio\",\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"${input:surrealdb-url}\",\n \"SURREALDB_NS\": \"${input:surrealdb-ns}\",\n \"SURREALDB_DB\": \"${input:surrealdb-db}\",\n \"SURREALDB_USER\": \"${input:surrealdb-user}\",\n \"SURREALDB_PASS\": \"${input:surrealdb-pass}\"\n }\n }\n }\n }\n ```\n\n > **참고:** 이 구성은 VS Code의 입력 변수를 사용하여 SurrealDB 자격 증명을 안전하게 묻고 저장합니다.\n\n2. **설치 확인:**\n\n * VS Code에서 GitHub Copilot Chat 열기\n * 드롭다운에서 \"에이전트\" 모드를 선택하세요\n * 사용 가능한 도구를 보려면 \"도구\" 버튼을 클릭하세요.\n * 목록에 SurrealDB 도구가 표시되어야 합니다.\n\n## 🦘 Roo 코드 설치\n\n### VS Code에서 Roo 코드 설치\n\n1. **MCP 설정에 액세스하세요.**\n\n Roo Code 창의 상단 탐색에서 MCP 아이콘을 클릭한 다음, \"MCP 설정 편집\"을 선택하여 구성 파일을 엽니다.\n\n2. **SurrealDB MCP 서버 구성을 추가합니다.**\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > **중요:** 경로에서 `YOUR_USERNAME` 실제 Windows 사용자 이름으로 바꾸세요.\n\n3. **VS 코드 재시작**\n\n4. **설치 확인:**\n\n * VS Code에서 Roo 코드 열기\n * 사용 가능한 서버를 보려면 MCP 아이콘을 클릭하세요.\n * 목록에 \"surrealdb\"가 표시되어야 합니다.\n\n## 🌊 윈드서핑 설치\n\n### 윈드서프 설치\n\n1. **패키지를 전역으로 설치합니다.**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **Windsurf 구성:**\n\n * 시스템에서 Windsurf를 엽니다.\n * 설정 페이지로 이동\n * 캐스케이드 탭으로 이동\n * 모델 컨텍스트 프로토콜(MCP) 서버 섹션 찾기\n * \"원시 구성 보기\"를 클릭하여 구성 파일을 엽니다(일반적으로 `~/.codeium/windsurf/mcp_config.json` 에 있음).\n\n3. **SurrealDB MCP 서버 구성을 추가합니다.**\n\n ```json\n {\n \"servers\": [\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ]\n }\n ```\n\n > **참고:** `/path/to/global/node_modules` 글로벌 node\\_modules 디렉토리의 실제 경로로 바꾸세요.\n\n4. **윈드서프 재시작**\n\n5. **설치 확인:**\n\n * 윈드서프의 오픈 캐스케이드\n * 도구 목록에서 SurrealDB 도구를 사용할 수 있어야 합니다.\n\n## ⚡ 커서 설치\n\n### 커서 설치\n\n1. **패키지를 전역으로 설치합니다.**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **커서 구성:**\n\n * 커서 열기\n * 설정 > 커서 설정으로 이동하세요\n * MCP 서버 옵션을 찾아 활성화하세요.\n * \"새 MCP 서버 추가\"를 클릭하세요.\n\n3. **SurrealDB MCP 서버 구성을 추가합니다.**\n\n ```json\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ```\n\n > **참고:** `/path/to/global/node_modules` 글로벌 node\\_modules 디렉토리의 실제 경로로 바꾸세요.\n\n4. **커서 재시작**\n\n5. **설치 확인:**\n\n * 커서 채팅 열기\n * 도구 목록에서 SurrealDB 도구를 사용할 수 있는지 확인해야 합니다.\n\n## 필수 환경 변수\n\n이 서버에는 SurrealDB 인스턴스에 연결하기 위해 다음 환경 변수가 필요합니다.\n\n* `SURREALDB_URL` : SurrealDB 인스턴스의 WebSocket 엔드포인트(예: `ws://localhost:8000` 또는 `wss://cloud.surrealdb.com` )입니다.\n* `SURREALDB_NS` : 대상 네임스페이스.\n* `SURREALDB_DB` : 대상 데이터베이스.\n* `SURREALDB_USER` : 인증을 위한 사용자 이름(Root, NS, DB 또는 Scope 사용자).\n* `SURREALDB_PASS` : 지정된 사용자의 비밀번호입니다.\n\n## 문제 해결\n\n### 일반적인 문제\n\n#### \"모듈을 찾을 수 없습니다\" 오류\n\n\"모듈 'surrealdb-mcp-server'를 찾을 수 없습니다\"와 같은 오류가 표시되면 다음을 시도해 보세요.\n\n1. 글로벌 설치를 확인하세요: `npm list -g surrealdb-mcp-server`\n2. 구성 경로가 실제 설치 경로와 일치하는지 확인하세요.\n3. 다시 설치해보세요: `npm install -g surrealdb-mcp-server`\n\n#### 연결 오류\n\n\"SurrealDB에 연결하지 못했습니다\"라는 메시지가 표시되면:\n\n1. SurrealDB가 실행 중인지 확인하세요: `surreal start --log debug`\n2. 연결 URL, 네임스페이스, 데이터베이스 및 자격 증명을 확인하세요.\n3. 지정된 경로에서 SurrealDB 인스턴스에 액세스할 수 있는지 확인하세요.\n\n#### 클라인 관련 문제\n\nnpx 접근 방식이 Cline에 적용되지 않는 경우:\n\n1. Cline의 경우 항상 글로벌 설치 방법을 사용하세요.\n2. node.exe와 설치된 패키지의 전체 경로를 지정하세요.\n3. YOUR\\_USERNAME을 실제 Windows 사용자 이름으로 바꿔야 합니다.\n\n## 고급 구성\n\n### 로컬 빌드 사용\n\n저장소를 복제했거나 로컬 빌드를 사용하려는 경우 다음 구성을 사용할 수 있습니다.\n\n```json\n{\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"node\",\n \"args\": [\"/path/to/your/surrealdb-mcp-server/build/index.js\"],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n}\n```\n\n* `/path/to/your/surrealdb-mcp-server` 저장소를 복제한 실제 경로로 바꾸십시오.\n* 환경 변수 값을 실제 SurrealDB 연결 세부 정보로 바꾸세요.\n\n## 개발\n\n이 MCP 서버 개발에 기여하고 싶다면 다음 단계를 따르세요.\n\n### 지역 개발 설정\n\n1. **저장소를 복제합니다.**\n\n ```bash\n git clone https://github.com/nsxdavid/surrealdb-mcp-server.git\n cd surrealdb-mcp-server\n ```\n\n2. **종속성 설치:**\n\n ```bash\n npm install\n ```\n\n3. **프로젝트를 빌드하세요:**\n\n ```bash\n npm run build\n ```\n\n### 지역적으로 실행\n\n```bash\n# Ensure required SURREALDB_* environment variables are set\nnpm run dev # (Note: dev script uses ts-node to run TypeScript directly)\n# Or run the built version:\nnpm start\n```\n\n### 테스트\n\n```bash\nnpm test # (Note: Tests need to be implemented)\n```\n\n### 기여하다\n\n기여를 환영합니다! 자세한 내용은 [CONTRIBUTING.md를](CONTRIBUTING.md) 참조하세요.\n\n## n8n과의 통합\n\n[n8n-nodes-mcp](https://github.com/nerding-io/n8n-nodes-mcp) 커뮤니티 노드를 사용하여 이 SurrealDB MCP 서버를 [n8n](https://n8n.io/) 과 통합할 수 있습니다.\n\n**참고: 현재 [n8n의 셀프 호스팅(Docker) 버전](https://docs.n8n.io/hosting/installation/docker/) 만 커뮤니티 노드를 지원합니다. n8n 클라우드 버전에는 MCP 서버 옵션이 아직 없습니다(아직인가요?).**\n\n### 설치\n\n1. **n8n-nodes-mcp 패키지를 설치하세요:**\n\n ```bash\n npm install n8n-nodes-mcp\n ```\n\n2. **n8n을 사용자 정의 노드를 사용하도록 구성합니다.**\n\n n8n 구성에 다음을 추가하세요.\n\n ```bash\n N8N_CUSTOM_EXTENSIONS=\"n8n-nodes-mcp\"\n ```\n\n3. **n8n에서 MCP 노드를 구성합니다.**\n\n * 워크플로에 \"MCP\" 노드를 추가합니다.\n * SurrealDB MCP 서버에 연결하도록 구성하세요.\n * 원하는 작업(쿼리, 선택, 생성 등)을 선택하세요.\n * 작업 매개변수 구성\n\n자세한 내용은 [n8n-nodes-mcp GitHub 저장소를](https://github.com/nerding-io/n8n-nodes-mcp) 방문하세요.\n\n## 특허\n\nMIT","Korean","ko-KR",{"_29":62,"_33":66,"_38":67},{"_31":63,"_33":64,"_35":65},"将您的 AI 模型连接到您最喜欢的 SurrealDB 数据库，让 LLM 为您完成所有工作。","SurrealDB MCP 服务器","# SurrealDB MCP 服务器\n\n模型上下文协议 (MCP) 服务器，为 AI 助手提供与[SurrealDB](https://surrealdb.com/)数据库交互的标准化接口。该服务器使 AI 系统能够查询和操作已配置的 SurrealDB 实例中的数据。\n\n> \\*\\*人工智能助手注意事项：\\*\\*如果您是阅读本文档的人工智能助手（如 Claude、Cline、Copilot 等），请参阅[llms-install.md](llms-install.md)文件，其中提供了专门为您设计的详细说明，以帮助用户安装和配置此 MCP 服务器。\n\n## 安装指南\n\n### 您使用哪款 AI 助手？\n\n* **📝 使用 Cline VS Code 扩展？** →[前往 Cline 安装](#cline-installation)\n* **🖥️ 使用 Claude 桌面应用？** →[前往 Claude 安装](#claude-installation)\n* **🤖 在 VS Code 中使用 GitHub Copilot？** →[前往 Copilot 安装](#copilot-installation)\n* **🦘 在 VS Code 中使用 Roo Code？** →[前往 Roo Code 安装](#roo-code-installation)\n* **🌊 使用 Windsurf？** →[前往 Windsurf 安装](#windsurf-installation)\n* **⚡ 使用 Cursor？** →[前往 Cursor 安装](#cursor-installation)\n* **🔄 使用[n8n](https://n8n.io/) ？** →[前往 n8n 集成](#integration-with-n8n)\n\n## 关键术语\n\n* **MCP 服务器**：实现模型上下文协议的服务器，允许 AI 助手访问外部工具和资源\n* **MCP 主机**：连接到 MCP 服务器的应用程序（例如带有 Cline 或 Claude Desktop 的 VS Code）\n* **[SurrealDB](https://surrealdb.com/)** ：具有实时功能的可扩展、分布式文档图数据库\n\n## 可用工具\n\n服务器公开了以下与 SurrealDB 交互的工具：\n\n* `query` ：执行原始 SurrealQL 查询。\n* `select` ：从表中选择记录（全部或按特定 ID）。\n* `create` ：在表中创建一条新记录。\n* `update` ：更新特定记录，替换其内容。\n* `delete` ：根据 ID 删除特定记录。\n* `merge` ：将数据合并到特定记录（部分更新）。\n* `patch` ：将 JSON Patch 操作应用于特定记录。\n* `upsert` ：如果不存在则创建记录，如果存在则更新记录。\n* `insert` ：将多条记录插入表中。\n* `insertRelation` ：在两个记录之间创建图形关系（边）。\n\n*（有关详细的输入模式，请参阅 MCP 主机的工具列表。）*\n\n## 📝 Cline 安装\n\n### Cline VS Code 扩展的一键安装\n\n1. **全局安装包：**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **添加到 Cline 设置：**\n\n 编辑以下文件： `%APPDATA%\\Code\\User\\globalStorage\\saoudrizwan.claude-dev\\settings\\cline_mcp_settings.json`\n\n 添加以下配置：\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > \\*\\*重要提示：\\*\\*将路径中的`YOUR_USERNAME`替换为您实际的 Windows 用户名。\n\n3. **重启 VS Code**\n\n4. **验证安装：**\n\n * 在 VS Code 中打开 Cline\n * 要求 Cline“列出可用的 MCP 服务器”\n * 您应该在列表中看到“surrealdb”\n\n## 🖥️ Claude 安装\n\n### Claude 桌面应用程序的安装\n\n1. **配置 Claude Desktop 以使用服务器：**\n\n 编辑 Claude 桌面应用程序的 MCP 设置文件：\n\n * Windows： `%APPDATA%\\Claude\\claude_desktop_config.json`\n * macOS： `~/Library/Application Support/Claude/claude_desktop_config.json`\n * Linux： `~/.config/Claude/claude_desktop_config.json`\n\n 添加以下配置：\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > \\*\\*注意：\\*\\*使用如上所示的`npx`命令意味着 MCP 客户端将在需要时自动从 npm 下载并运行软件包。无需手动安装。\n\n2. **重启 Claude 桌面应用程序**\n\n3. **验证安装：**\n\n * 要求 Claude“列出可用的 MCP 服务器”\n * 您应该在列表中看到“surrealdb”\n\n## 🤖 Copilot 安装\n\n### 在 VS Code 中安装 GitHub Copilot\n\n1. **创建工作区配置文件：**\n\n 在你的工作区中创建一个文件： `.vscode/mcp.json`\n\n 添加以下配置：\n\n ```json\n {\n \"inputs\": [\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-url\",\n \"description\": \"SurrealDB URL\",\n \"default\": \"ws://localhost:8000\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-ns\",\n \"description\": \"SurrealDB Namespace\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-db\",\n \"description\": \"SurrealDB Database\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-user\",\n \"description\": \"SurrealDB Username\"\n },\n {\n \"type\": \"promptString\",\n \"id\": \"surrealdb-pass\",\n \"description\": \"SurrealDB Password\",\n \"password\": true\n }\n ],\n \"servers\": {\n \"surrealdb\": {\n \"type\": \"stdio\",\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"surrealdb-mcp-server\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"${input:surrealdb-url}\",\n \"SURREALDB_NS\": \"${input:surrealdb-ns}\",\n \"SURREALDB_DB\": \"${input:surrealdb-db}\",\n \"SURREALDB_USER\": \"${input:surrealdb-user}\",\n \"SURREALDB_PASS\": \"${input:surrealdb-pass}\"\n }\n }\n }\n }\n ```\n\n > \\*\\*注意：\\*\\*此配置使用 VS Code 的输入变量来安全地提示和存储您的 SurrealDB 凭据。\n\n2. **验证安装：**\n\n * 在 VS Code 中打开 GitHub Copilot Chat\n * 从下拉菜单中选择“代理”模式\n * 点击“工具”按钮查看可用工具\n * 您应该在列表中看到 SurrealDB 工具\n\n## 🦘 Roo 代码安装\n\n### 在 VS Code 中安装 Roo Code\n\n1. **访问 MCP 设置：**\n\n 单击 Roo 代码窗格顶部导航中的 MCP 图标，然后选择“编辑 MCP 设置”以打开配置文件。\n\n2. **添加 SurrealDB MCP 服务器配置：**\n\n ```json\n {\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"C:\\\\Program Files\\\\nodejs\\\\node.exe\",\n \"args\": [\n \"C:\\\\Users\\\\YOUR_USERNAME\\\\AppData\\\\Roaming\\\\npm\\\\node_modules\\\\surrealdb-mcp-server\\\\build\\\\index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n }\n ```\n\n > \\*\\*重要提示：\\*\\*将路径中的`YOUR_USERNAME`替换为您实际的 Windows 用户名。\n\n3. **重启 VS Code**\n\n4. **验证安装：**\n\n * 在 VS Code 中打开 Roo Code\n * 点击 MCP 图标查看可用的服务器\n * 您应该在列表中看到“surrealdb”\n\n## 🌊 风帆冲浪安装\n\n### 风帆冲浪安装\n\n1. **全局安装包：**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **配置 Windsurf：**\n\n * 在您的系统上打开 Windsurf\n * 导航至“设置”页面\n * 转到“Cascade”选项卡\n * 查找模型上下文协议 (MCP) 服务器部分\n * 单击“查看原始配置”以打开配置文件（通常位于`~/.codeium/windsurf/mcp_config.json` ）\n\n3. **添加 SurrealDB MCP 服务器配置：**\n\n ```json\n {\n \"servers\": [\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ]\n }\n ```\n\n > \\*\\*注意：\\*\\*将`/path/to/global/node_modules`替换为全局 node\\_modules 目录的实际路径。\n\n4. **重启风帆冲浪**\n\n5. **验证安装：**\n\n * 在风帆冲浪中打开 Cascade\n * 您应该在工具列表中看到可用的 SurrealDB 工具\n\n## ⚡ 光标安装\n\n### Cursor 的安装\n\n1. **全局安装包：**\n\n ```bash\n npm install -g surrealdb-mcp-server\n ```\n\n2. **配置光标：**\n\n * 打开游标\n * 前往“设置”>“光标设置”\n * 找到 MCP 服务器选项并启用它\n * 点击“添加新的 MCP 服务器”\n\n3. **添加 SurrealDB MCP 服务器配置：**\n\n ```json\n {\n \"name\": \"surrealdb\",\n \"command\": \"node\",\n \"args\": [\n \"/path/to/global/node_modules/surrealdb-mcp-server/build/index.js\"\n ],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n }\n }\n ```\n\n > \\*\\*注意：\\*\\*将`/path/to/global/node_modules`替换为全局 node\\_modules 目录的实际路径。\n\n4. **重启光标**\n\n5. **验证安装：**\n\n * 打开光标聊天\n * 您应该在工具列表中看到可用的 SurrealDB 工具\n\n## 必需的环境变量\n\n此服务器需要以下环境变量才能连接到您的 SurrealDB 实例：\n\n* `SURREALDB_URL` ：您的 SurrealDB 实例的 WebSocket 端点（例如， `ws://localhost:8000`或`wss://cloud.surrealdb.com` ）。\n* `SURREALDB_NS` ：目标命名空间。\n* `SURREALDB_DB` ：目标数据库。\n* `SURREALDB_USER` ：用于身份验证的用户名（Root、NS、DB 或 Scope 用户）。\n* `SURREALDB_PASS` ：指定用户的密码。\n\n## 故障排除\n\n### 常见问题\n\n#### “找不到模块”错误\n\n如果您看到类似“找不到模块‘surrealdb-mcp-server’”的错误，请尝试：\n\n1. 验证全局安装： `npm list -g surrealdb-mcp-server`\n2. 检查配置中的路径是否与实际安装路径相符\n3. 尝试重新安装： `npm install -g surrealdb-mcp-server`\n\n#### 连接错误\n\n如果您看到“无法连接到 SurrealDB”：\n\n1. 验证 SurrealDB 是否正在运行： `surreal start --log debug`\n2. 检查您的连接 URL、命名空间、数据库和凭据\n3. 确保您的 SurrealDB 实例可以从指定的路径访问\n\n#### 克莱恩特有的问题\n\n如果 npx 方法不适用于 Cline：\n\n1. 始终使用 Cline 的全局安装方法\n2. 指定node.exe和已安装包的完整路径\n3. 确保将 YOUR\\_USERNAME 替换为您的实际 Windows 用户名\n\n## 高级配置\n\n### 使用本地构建\n\n如果您已经克隆了存储库或想要使用本地构建，则可以使用此配置：\n\n```json\n{\n \"mcpServers\": {\n \"surrealdb\": {\n \"command\": \"node\",\n \"args\": [\"/path/to/your/surrealdb-mcp-server/build/index.js\"],\n \"env\": {\n \"SURREALDB_URL\": \"ws://localhost:8000\",\n \"SURREALDB_NS\": \"your_namespace\",\n \"SURREALDB_DB\": \"your_database\",\n \"SURREALDB_USER\": \"your_db_user\",\n \"SURREALDB_PASS\": \"your_db_password\"\n },\n \"disabled\": false,\n \"autoApprove\": []\n }\n }\n}\n```\n\n* 将`/path/to/your/surrealdb-mcp-server`替换为您克隆存储库的实际路径\n* 用实际的 SurrealDB 连接详细信息替换环境变量值\n\n## 发展\n\n如果您想为该 MCP 服务器的开发做出贡献，请按照以下步骤操作：\n\n### 本地开发设置\n\n1. **克隆存储库：**\n\n ```bash\n git clone https://github.com/nsxdavid/surrealdb-mcp-server.git\n cd surrealdb-mcp-server\n ```\n\n2. **安装依赖项：**\n\n ```bash\n npm install\n ```\n\n3. **构建项目：**\n\n ```bash\n npm run build\n ```\n\n### 本地运行\n\n```bash\n# Ensure required SURREALDB_* environment variables are set\nnpm run dev # (Note: dev script uses ts-node to run TypeScript directly)\n# Or run the built version:\nnpm start\n```\n\n### 测试\n\n```bash\nnpm test # (Note: Tests need to be implemented)\n```\n\n### 贡献\n\n欢迎贡献！请参阅[CONTRIBUTING.md](CONTRIBUTING.md)获取相关指南。\n\n## 与 n8n 集成\n\n您可以使用[n8n-nodes-mcp](https://github.com/nerding-io/n8n-nodes-mcp)社区节点将此 SurrealDB MCP 服务器与[n8n](https://n8n.io/)集成。\n\n**注意：目前只有[n8n 自托管（Docker）版本](https://docs.n8n.io/hosting/installation/docker/)支持社区节点。n8n 云版本暂不支持 MCP 服务器选项（目前还不支持）。**\n\n### 安装\n\n1. **安装 n8n-nodes-mcp 包：**\n\n ```bash\n npm install n8n-nodes-mcp\n ```\n\n2. **配置 n8n 以使用自定义节点：**\n\n 将以下内容添加到您的 n8n 配置：\n\n ```bash\n N8N_CUSTOM_EXTENSIONS=\"n8n-nodes-mcp\"\n ```\n\n3. **在 n8n 中配置 MCP 节点：**\n\n * 将“MCP”节点添加到您的工作流程中\n * 配置它以连接到您的 SurrealDB MCP 服务器\n * 选择所需的操作（查询、选择、创建等）\n * 配置运行参数\n\n有关更多详细信息，请访问[n8n-nodes-mcp GitHub 存储库](https://github.com/nerding-io/n8n-nodes-mcp)。\n\n## 执照\n\n麻省理工学院","Chinese","zh-CN","githubUser","locale",{"_71":72,"_73":-5,"_13":74,"_81":32,"_82":32,"_83":84,"_87":88,"_109":-5,"_16":110,"_111":112,"_113":114,"_33":34,"_115":101,"_116":-5,"_117":-5,"_118":-5,"_119":-5,"_120":121,"_125":-5,"_126":97,"_127":-5,"_128":-5,"_102":129,"_130":131},"addedAt","2025-04-08T04:15:57.946946382Z","argumentsJsonSchema",[75,76,77,78,79,80],"category:databases","category:agent-orchestration","category:developer-tools","environment:local","hosting:remote-capable","language:javascript","descriptionMarkdown","descriptionPlainText","githubProject",{"_35":36,"_85":86},"url","https://github.com/nsxdavid/surrealdb-mcp-server","githubRepository",{"_89":90,"_91":92,"_93":94,"_95":96,"_33":97,"_98":99,"_104":105,"_106":-5,"_107":108},"defaultBranch","main","fullName","nsxdavid/surrealdb-mcp-server","githubTreeId",106410,"language","JavaScript","surrealdb-mcp-server","owner",{"_100":101,"_102":103},"login","nsxdavid","uid","8NYxqXbQRG","recentStargazers",0,"spdxLicense","stargazers",3,"glamaJson",5162,"inspectable",false,"integrations",[],"namespace","npmPackage","prompts","redditPostForeignId","resources","scores",{"_122":-5,"_123":-5,"_124":-5},"license","quality","security","simpleIcon","slug","supportedPlatforms","tools","hi3bgwz23f","updatedAt","2025-04-10T00:00:44.209209588Z","meta",[134,137,139,146,149,151,154,157,160,163,166,168,171,174,176,178,180,182,184],{"_135":136},"title","SurrealDB MCP Server | Glama",{"_138":32,"_33":31},"content",{"_140":141,"_142":143,"_144":145},"href","https://glama.ai/mcp/servers/@nsxdavid/surrealdb-mcp-server","rel","canonical","tagName","link",{"_138":34,"_147":148},"property","og:title",{"_138":32,"_147":150},"og:description",{"_138":152,"_147":153},"https://glama.ai/logo.png","og:logo",{"_138":155,"_147":156},"https://glama.ai/mcp/servers/@nsxdavid/surrealdb-mcp-server/og-image","og:image",{"_138":158,"_147":159},"630","og:image:height",{"_138":161,"_147":162},"1200","og:image:width",{"_138":164,"_147":165},"website","og:type",{"_138":141,"_147":167},"og:url",{"_138":169,"_147":170},"Glama – MCP Hosting Platform","og:site_name",{"_138":172,"_33":173},"summary_large_image","twitter:card",{"_138":169,"_33":175},"twitter:title",{"_138":32,"_33":177},"twitter:description",{"_138":155,"_33":179},"twitter:image",{"_138":158,"_33":181},"twitter:image:height",{"_138":161,"_33":183},"twitter:image:width",{"_185":186},"script:ld+json",{"_187":188,"_189":190},"@context","http://schema.org","@graph",[191],{"_187":192,"_193":194,"_195":196},"https://schema.org","@type","BreadcrumbList","itemListElement",[197,204,208,211],{"_193":198,"_199":200,"_33":201,"_202":203},"ListItem","item","https://glama.ai/","Glama","position",1,{"_193":198,"_199":205,"_33":206,"_202":207},"https://glama.ai/mcp","MCP",2,{"_193":198,"_199":209,"_33":210,"_202":108},"https://glama.ai/mcp/servers","Servers",{"_193":198,"_199":141,"_33":34,"_202":212},4,"visitorIsMaintainer","routes/_public/mcp/servers/~namespace/~slug/_pages/reviews/_route",{"_68":-5,"_29":216,"_132":223,"_258":-5},{"_71":72,"_73":-5,"_13":217,"_81":32,"_82":32,"_83":218,"_87":219,"_109":-5,"_16":110,"_111":112,"_113":221,"_33":34,"_115":101,"_116":-5,"_117":-5,"_118":-5,"_119":-5,"_120":222,"_125":-5,"_126":97,"_127":-5,"_128":-5,"_102":129,"_130":131},[75,76,77,78,79,80],{"_35":36,"_85":86},{"_89":90,"_91":92,"_93":94,"_95":96,"_33":97,"_98":220,"_104":105,"_106":-5,"_107":108},{"_100":101,"_102":103},[],{"_122":-5,"_123":-5,"_124":-5},[224,226,228,230,232,233,234,235,236,237,238,239,240,241,242,243,244,245,246],{"_135":225},"Reviews | SurrealDB MCP Server | Glama",{"_138":227,"_33":31},"Read community reviews and feedback for SurrealDB MCP Server. Discover user experiences, ratings, strengths, and potential limitations of this MCP implementation from actual users.",{"_140":229,"_142":143,"_144":145},"https://glama.ai/mcp/servers/@nsxdavid/surrealdb-mcp-server/reviews",{"_138":231,"_147":148},"Reviews | SurrealDB MCP Server",{"_138":227,"_147":150},{"_138":152,"_147":153},{"_138":155,"_147":156},{"_138":158,"_147":159},{"_138":161,"_147":162},{"_138":164,"_147":165},{"_138":229,"_147":167},{"_138":169,"_147":170},{"_138":172,"_33":173},{"_138":169,"_33":175},{"_138":227,"_33":177},{"_138":155,"_33":179},{"_138":158,"_33":181},{"_138":161,"_33":183},{"_185":247},{"_187":188,"_189":248},[249],{"_187":192,"_193":194,"_195":250},[251,252,253,254,255],{"_193":198,"_199":200,"_33":201,"_202":203},{"_193":198,"_199":205,"_33":206,"_202":207},{"_193":198,"_199":209,"_33":210,"_202":108},{"_193":198,"_199":141,"_33":34,"_202":212},{"_193":198,"_199":229,"_33":256,"_202":257},"Reviews",5,"review","actionData","errors"]

Rate & Review

MCP directory API