SurrealDB MCP Server

by nsxdavid

SurrealDB MCP 서버

AI 어시스턴트가 SurrealDB 데이터베이스와 상호 작용할 수 있도록 표준화된 인터페이스를 제공하는 모델 컨텍스트 프로토콜(MCP) 서버입니다. 이 서버를 통해 AI 시스템은 구성된 SurrealDB 인스턴스 내에서 데이터를 쿼리하고 조작할 수 있습니다.

AI 보조원을 위한 참고 사항: 클로드, 클라인, 코파일럿 등과 같은 AI 보조원이 이 문서를 읽고 있다면, 사용자가 이 MCP 서버를 설치하고 구성하는 데 도움이 되도록 특별히 고안된 자세한 지침이 있는 llms-install.md 파일을 참조하세요.

설치 가이드

어떤 AI 비서를 사용하고 계신가요?

주요 용어

  • MCP 서버 : AI 어시스턴트가 외부 도구 및 리소스에 액세스할 수 있도록 하는 모델 컨텍스트 프로토콜을 구현하는 서버
  • MCP 호스트 : MCP 서버에 연결하는 애플리케이션(Cline 또는 Claude Desktop이 포함된 VS Code 등)
  • SurrealDB : 실시간 기능을 갖춘 확장 가능한 분산 문서 그래프 데이터베이스

사용 가능한 도구

서버는 SurrealDB와 상호 작용하기 위해 다음과 같은 도구를 제공합니다.

  • query : 원시 SurrealQL 쿼리를 실행합니다.
  • select : 테이블에서 레코드를 선택합니다(전체 또는 특정 ID로).
  • create : 테이블에 단일 새 레코드를 만듭니다.
  • update : 특정 레코드를 업데이트하여 해당 내용을 바꿉니다.
  • delete : ID로 특정 레코드를 삭제합니다.
  • merge : 특정 레코드에 데이터를 병합합니다(부분 업데이트).
  • patch : 특정 레코드에 JSON 패치 작업을 적용합니다.
  • upsert : 레코드가 없으면 생성하고, 있으면 업데이트합니다.
  • insert : 테이블에 여러 개의 레코드를 삽입합니다.
  • insertRelation : 두 레코드 간의 그래프 관계(에지)를 생성합니다.

(자세한 입력 스키마는 MCP 호스트의 도구 목록을 참조하세요.)

📝 클라인 설치

Cline VS Code 확장 프로그램을 위한 원클릭 설치

  1. 패키지를 전역으로 설치합니다.지엑스피1
  2. Cline 설정에 추가:%APPDATA%\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json 에서 파일을 편집하세요.다음 구성을 추가합니다.
    { "mcpServers": { "surrealdb": { "command": "C:\\Program Files\\nodejs\\node.exe", "args": [ "C:\\Users\\YOUR_USERNAME\\AppData\\Roaming\\npm\\node_modules\\surrealdb-mcp-server\\build\\index.js" ], "env": { "SURREALDB_URL": "ws://localhost:8000", "SURREALDB_NS": "your_namespace", "SURREALDB_DB": "your_database", "SURREALDB_USER": "your_db_user", "SURREALDB_PASS": "your_db_password" }, "disabled": false, "autoApprove": [] } } }

    중요: 경로에서 YOUR_USERNAME 실제 Windows 사용자 이름으로 바꾸세요.

  3. VS 코드 재시작
  4. 설치 확인:
    • VS Code에서 Cline 열기
    • Cline에게 "사용 가능한 MCP 서버 나열"을 요청하세요.
    • 목록에 "surrealdb"가 표시되어야 합니다.

🖥️ 클로드 설치

Claude 데스크톱 앱 설치

  1. Claude Desktop을 구성하여 서버를 사용합니다.Claude Desktop App의 MCP 설정 파일을 편집합니다.
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • 리눅스: ~/.config/Claude/claude_desktop_config.json

    다음 구성을 추가합니다.

    { "mcpServers": { "surrealdb": { "command": "npx", "args": [ "-y", "surrealdb-mcp-server" ], "env": { "SURREALDB_URL": "ws://localhost:8000", "SURREALDB_NS": "your_namespace", "SURREALDB_DB": "your_database", "SURREALDB_USER": "your_db_user", "SURREALDB_PASS": "your_db_password" }, "disabled": false, "autoApprove": [] } } }

    참고: 위에 표시된 대로 npx 명령을 사용하면 MCP 클라이언트가 필요 시 npm에서 패키지를 자동으로 다운로드하여 실행합니다. 수동 설치는 필요하지 않습니다.

  2. Claude 데스크톱 앱을 다시 시작하세요
  3. 설치 확인:
    • Claude에게 "사용 가능한 MCP 서버 나열"을 요청하세요.
    • 목록에 "surrealdb"가 표시되어야 합니다.

🤖 Copilot 설치

VS Code에서 GitHub Copilot 설치

  1. 작업 공간 구성 파일을 만듭니다.작업 공간에서 .vscode/mcp.json 파일을 만듭니다.다음 구성을 추가합니다.
    { "inputs": [ { "type": "promptString", "id": "surrealdb-url", "description": "SurrealDB URL", "default": "ws://localhost:8000" }, { "type": "promptString", "id": "surrealdb-ns", "description": "SurrealDB Namespace" }, { "type": "promptString", "id": "surrealdb-db", "description": "SurrealDB Database" }, { "type": "promptString", "id": "surrealdb-user", "description": "SurrealDB Username" }, { "type": "promptString", "id": "surrealdb-pass", "description": "SurrealDB Password", "password": true } ], "servers": { "surrealdb": { "type": "stdio", "command": "npx", "args": [ "-y", "surrealdb-mcp-server" ], "env": { "SURREALDB_URL": "${input:surrealdb-url}", "SURREALDB_NS": "${input:surrealdb-ns}", "SURREALDB_DB": "${input:surrealdb-db}", "SURREALDB_USER": "${input:surrealdb-user}", "SURREALDB_PASS": "${input:surrealdb-pass}" } } } }

    참고: 이 구성은 VS Code의 입력 변수를 사용하여 SurrealDB 자격 증명을 안전하게 묻고 저장합니다.

  2. 설치 확인:
    • VS Code에서 GitHub Copilot Chat 열기
    • 드롭다운에서 "에이전트" 모드를 선택하세요
    • 사용 가능한 도구를 보려면 "도구" 버튼을 클릭하세요.
    • 목록에 SurrealDB 도구가 표시되어야 합니다.

🦘 Roo 코드 설치

VS Code에서 Roo 코드 설치

  1. MCP 설정에 액세스하세요.Roo Code 창의 상단 탐색에서 MCP 아이콘을 클릭한 다음, "MCP 설정 편집"을 선택하여 구성 파일을 엽니다.
  2. SurrealDB MCP 서버 구성을 추가합니다.
    { "mcpServers": { "surrealdb": { "command": "C:\\Program Files\\nodejs\\node.exe", "args": [ "C:\\Users\\YOUR_USERNAME\\AppData\\Roaming\\npm\\node_modules\\surrealdb-mcp-server\\build\\index.js" ], "env": { "SURREALDB_URL": "ws://localhost:8000", "SURREALDB_NS": "your_namespace", "SURREALDB_DB": "your_database", "SURREALDB_USER": "your_db_user", "SURREALDB_PASS": "your_db_password" }, "disabled": false, "autoApprove": [] } } }

    중요: 경로에서 YOUR_USERNAME 실제 Windows 사용자 이름으로 바꾸세요.

  3. VS 코드 재시작
  4. 설치 확인:
    • VS Code에서 Roo 코드 열기
    • 사용 가능한 서버를 보려면 MCP 아이콘을 클릭하세요.
    • 목록에 "surrealdb"가 표시되어야 합니다.

🌊 윈드서핑 설치

윈드서프 설치

  1. 패키지를 전역으로 설치합니다.
    npm install -g surrealdb-mcp-server
  2. Windsurf 구성:
    • 시스템에서 Windsurf를 엽니다.
    • 설정 페이지로 이동
    • 캐스케이드 탭으로 이동
    • 모델 컨텍스트 프로토콜(MCP) 서버 섹션 찾기
    • "원시 구성 보기"를 클릭하여 구성 파일을 엽니다(일반적으로 ~/.codeium/windsurf/mcp_config.json 에 있음).
  3. SurrealDB MCP 서버 구성을 추가합니다.
    { "servers": [ { "name": "surrealdb", "command": "node", "args": [ "/path/to/global/node_modules/surrealdb-mcp-server/build/index.js" ], "env": { "SURREALDB_URL": "ws://localhost:8000", "SURREALDB_NS": "your_namespace", "SURREALDB_DB": "your_database", "SURREALDB_USER": "your_db_user", "SURREALDB_PASS": "your_db_password" } } ] }

    참고: /path/to/global/node_modules 글로벌 node_modules 디렉토리의 실제 경로로 바꾸세요.

  4. 윈드서프 재시작
  5. 설치 확인:
    • 윈드서프의 오픈 캐스케이드
    • 도구 목록에서 SurrealDB 도구를 사용할 수 있어야 합니다.

⚡ 커서 설치

커서 설치

  1. 패키지를 전역으로 설치합니다.
    npm install -g surrealdb-mcp-server
  2. 커서 구성:
    • 커서 열기
    • 설정 > 커서 설정으로 이동하세요
    • MCP 서버 옵션을 찾아 활성화하세요.
    • "새 MCP 서버 추가"를 클릭하세요.
  3. SurrealDB MCP 서버 구성을 추가합니다.
    { "name": "surrealdb", "command": "node", "args": [ "/path/to/global/node_modules/surrealdb-mcp-server/build/index.js" ], "env": { "SURREALDB_URL": "ws://localhost:8000", "SURREALDB_NS": "your_namespace", "SURREALDB_DB": "your_database", "SURREALDB_USER": "your_db_user", "SURREALDB_PASS": "your_db_password" } }

    참고: /path/to/global/node_modules 글로벌 node_modules 디렉토리의 실제 경로로 바꾸세요.

  4. 커서 재시작
  5. 설치 확인:
    • 커서 채팅 열기
    • 도구 목록에서 SurrealDB 도구를 사용할 수 있는지 확인해야 합니다.

필수 환경 변수

이 서버에는 SurrealDB 인스턴스에 연결하기 위해 다음 환경 변수가 필요합니다.

  • SURREALDB_URL : SurrealDB 인스턴스의 WebSocket 엔드포인트(예: ws://localhost:8000 또는 wss://cloud.surrealdb.com )입니다.
  • SURREALDB_NS : 대상 네임스페이스.
  • SURREALDB_DB : 대상 데이터베이스.
  • SURREALDB_USER : 인증을 위한 사용자 이름(Root, NS, DB 또는 Scope 사용자).
  • SURREALDB_PASS : 지정된 사용자의 비밀번호입니다.

문제 해결

일반적인 문제

"모듈을 찾을 수 없습니다" 오류

"모듈 'surrealdb-mcp-server'를 찾을 수 없습니다"와 같은 오류가 표시되면 다음을 시도해 보세요.

  1. 글로벌 설치를 확인하세요: npm list -g surrealdb-mcp-server
  2. 구성 경로가 실제 설치 경로와 일치하는지 확인하세요.
  3. 다시 설치해보세요: npm install -g surrealdb-mcp-server
연결 오류

"SurrealDB에 연결하지 못했습니다"라는 메시지가 표시되면:

  1. SurrealDB가 실행 중인지 확인하세요: surreal start --log debug
  2. 연결 URL, 네임스페이스, 데이터베이스 및 자격 증명을 확인하세요.
  3. 지정된 경로에서 SurrealDB 인스턴스에 액세스할 수 있는지 확인하세요.
클라인 관련 문제

npx 접근 방식이 Cline에 적용되지 않는 경우:

  1. Cline의 경우 항상 글로벌 설치 방법을 사용하세요.
  2. node.exe와 설치된 패키지의 전체 경로를 지정하세요.
  3. YOUR_USERNAME을 실제 Windows 사용자 이름으로 바꿔야 합니다.

고급 구성

로컬 빌드 사용

저장소를 복제했거나 로컬 빌드를 사용하려는 경우 다음 구성을 사용할 수 있습니다.

{ "mcpServers": { "surrealdb": { "command": "node", "args": ["/path/to/your/surrealdb-mcp-server/build/index.js"], "env": { "SURREALDB_URL": "ws://localhost:8000", "SURREALDB_NS": "your_namespace", "SURREALDB_DB": "your_database", "SURREALDB_USER": "your_db_user", "SURREALDB_PASS": "your_db_password" }, "disabled": false, "autoApprove": [] } } }
  • /path/to/your/surrealdb-mcp-server 저장소를 복제한 실제 경로로 바꾸십시오.
  • 환경 변수 값을 실제 SurrealDB 연결 세부 정보로 바꾸세요.

개발

이 MCP 서버 개발에 기여하고 싶다면 다음 단계를 따르세요.

지역 개발 설정

  1. 저장소를 복제합니다.
    git clone https://github.com/nsxdavid/surrealdb-mcp-server.git cd surrealdb-mcp-server
  2. 종속성 설치:
    npm install
  3. 프로젝트를 빌드하세요:
    npm run build

지역적으로 실행

# Ensure required SURREALDB_* environment variables are set npm run dev # (Note: dev script uses ts-node to run TypeScript directly) # Or run the built version: npm start

테스트

npm test # (Note: Tests need to be implemented)

기여하다

기여를 환영합니다! 자세한 내용은 CONTRIBUTING.md를 참조하세요.

n8n과의 통합

n8n-nodes-mcp 커뮤니티 노드를 사용하여 이 SurrealDB MCP 서버를 n8n 과 통합할 수 있습니다.

참고: 현재 n8n의 셀프 호스팅(Docker) 버전 만 커뮤니티 노드를 지원합니다. n8n 클라우드 버전에는 MCP 서버 옵션이 아직 없습니다(아직인가요?).

설치

  1. n8n-nodes-mcp 패키지를 설치하세요:
    npm install n8n-nodes-mcp
  2. n8n을 사용자 정의 노드를 사용하도록 구성합니다.n8n 구성에 다음을 추가하세요.
    N8N_CUSTOM_EXTENSIONS="n8n-nodes-mcp"
  3. n8n에서 MCP 노드를 구성합니다.
    • 워크플로에 "MCP" 노드를 추가합니다.
    • SurrealDB MCP 서버에 연결하도록 구성하세요.
    • 원하는 작업(쿼리, 선택, 생성 등)을 선택하세요.
    • 작업 매개변수 구성

자세한 내용은 n8n-nodes-mcp GitHub 저장소를 방문하세요.

특허

MIT

Related MCP Servers

  • A
    security
    A
    license
    A
    quality
    Provides AI models with structured access to Trino's distributed SQL query engine, enabling LLMs to directly query and analyze data stored in Trino databases.
    Last updated -
    3
    1
    Python
    MIT License
  • -
    security
    A
    license
    -
    quality
    Allows AI models to interact with SourceSync.ai's knowledge management platform to organize, ingest, retrieve, and search content in knowledge bases.
    Last updated -
    14
    1
    TypeScript
    MIT License
    • Apple
    • Linux
  • -
    security
    A
    license
    -
    quality
    An MCP server implementation that integrates AI assistants with Langfuse workspaces, allowing models to query LLM metrics by time range.
    Last updated -
    9
    JavaScript
    Apache 2.0
  • -
    security
    A
    license
    -
    quality
    Enables AI agents to interact with multiple LLM providers (OpenAI, Anthropic, Google, DeepSeek) through a standardized interface, making it easy to switch between models or use multiple models in the same application.
    Last updated -
    3
    Python
    MIT License
    • Linux
    • Apple

View all related MCP servers

ID: hi3bgwz23f