hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

Provides database interaction capabilities with ArangoDB, implementing core operations like executing AQL queries, inserting/updating/removing documents, creating and listing collections, and backing up data to JSON files.

ArangoDB용 MCP 서버

ArangoDB용 모델 컨텍스트 프로토콜 서버

ArangoDB를 통해 데이터베이스 상호작용 기능을 제공하는 TypeScript 기반 MCP 서버입니다. 핵심 데이터베이스 작업을 구현하고 MCP 도구를 통해 ArangoDB와 원활하게 통합할 수 있습니다. Claude 앱과 함께 사용할 수 있으며, Cline처럼 MCP와 호환되는 VSCode 확장 프로그램도 사용할 수 있습니다!

특징

도구

arango_query - AQL 쿼리 실행
- 필수 매개변수로 AQL 쿼리 문자열을 사용합니다.
- 매개변수화된 쿼리에 대한 바인드 변수를 선택적으로 허용합니다.
- 쿼리 결과를 JSON으로 반환합니다.
arango_insert - 컬렉션에 문서 삽입
- 필수 매개변수로 컬렉션 이름과 문서 객체를 사용합니다.
- 제공되지 않으면 자동으로 문서 키가 생성됩니다.
- 생성된 문서 메타데이터를 반환합니다.
arango_update - 기존 문서 업데이트
- 필수 매개변수로 컬렉션 이름, 문서 키 및 업데이트 객체를 사용합니다.
- 업데이트된 문서 메타데이터를 반환합니다.
arango_remove - 컬렉션에서 문서 제거
- 필수 매개변수로 컬렉션 이름과 문서 키를 사용합니다.
- 제거된 문서 메타데이터를 반환합니다.
arango_backup - 모든 컬렉션을 JSON 파일로 백업
- 출력 디렉토리 경로를 필수 매개변수로 사용합니다.
- 현재 데이터를 사용하여 각 컬렉션에 대한 JSON 파일을 생성합니다.
- 데이터 백업 및 마이그레이션 목적으로 유용합니다.
arango_list_collections - 데이터베이스의 모든 컬렉션을 나열합니다.
- 이름, ID, 유형을 포함한 컬렉션 정보 배열을 반환합니다.
arango_create_collection - 데이터베이스에 새 컬렉션을 만듭니다.
- 필수 매개변수로 컬렉션 이름을 사용합니다.
- 선택적으로 컬렉션 유형(문서 또는 에지 컬렉션)을 지정합니다.
- 쓰기 작업에 대한 waitForSync 동작 구성
- 이름, 유형, 상태를 포함한 컬렉션 정보를 반환합니다.

데이터베이스 구조

이 서버는 데이터베이스 구조에 구애받지 않으며 ArangoDB의 문서 및 에지 컬렉션 모델을 따르는 한 모든 컬렉션 이름이나 구조로 작업할 수 있습니다.

개발

종속성 설치:

지엑스피1

자동 재빌드를 사용한 개발의 경우:

npm run watch

설치

Smithery를 통해 설치

Smithery를 통해 Claude Desktop에 ArangoDB를 자동으로 설치하려면:

npx -y @smithery/cli install @ravenwits/mcp-server-arangodb --client claude

Claude Desktop과 함께 사용하려면 서버 구성을 추가하세요.

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
윈도우: %APPDATA%/Claude/claude_desktop_config.json

Cline VSCode Extension과 함께 사용하려면 서버 구성을 추가하세요.

MacOS: ~/Library/Application Support/Code/User/globalStorage/cline.cline/config.json
윈도우: %APPDATA%/Code/User/globalStorage/cline.cline/config.json

mcpServers 섹션에 다음 구성을 추가합니다.

{
  "mcpServers": {
    "arango": {
      "command": "node",
      "args": ["/path/to/arango-server/build/index.js"],
      "env": {
        "ARANGO_URL": "your_database_url",
        "ARANGO_DATABASE": "your_database_name",
        "ARANGO_USERNAME": "your_username",
        "ARANGO_PASSWORD": "your_password"
      }
    }
  }
}

환경 변수

서버에는 다음과 같은 환경 변수가 필요합니다.

ARANGO_URL - ArangoDB 서버 URL(참고: 8529는 로컬 개발을 위한 ArangoDB의 기본 포트입니다)
ARANGO_DATABASE - 데이터베이스 이름
ARANGO_USERNAME - 데이터베이스 사용자
ARANGO_PASSWORD - 데이터베이스 비밀번호

사용 예

의미 있는 프롬프트를 제공하면 클로드가 적절한 기능을 실행하려고 할 것입니다.

몇 가지 예시 프롬프트:

"데이터베이스의 모든 컬렉션을 나열합니다"
"모든 사용자 쿼리"
"이름이 'John Doe'인 새 문서를 삽입하고 ' john@example.com '을 'users' 컬렉션으로 이메일로 보냅니다."
"키 '123456' 또는 이름 'Jane Doe'로 문서를 업데이트하여 나이를 48세로 변경하세요."
"'제품'이라는 이름의 새 컬렉션을 만듭니다."

Claude 앱과 함께 사용

Cline VSCode 확장을 사용한 Uasge

모든 사용자에게 쿼리:

{
  "query": "FOR user IN users RETURN user"
}

새 문서 삽입:

{
  "collection": "users",
  "document": {
    "name": "John Doe",
    "email": "john@example.com"
  }
}

문서 업데이트:

{
  "collection": "users",
  "key": "123456",
  "update": {
    "name": "Jane Doe"
  }
}

문서 제거:

{
  "collection": "users",
  "key": "123456"
}

모든 컬렉션 나열:

{} // No parameters required

백업 데이터베이스 컬렉션:

{
  "outputDir": "./backup" // Specify an absolute output directory path for the backup files (optional)
  "collection": "users" // Specify a collection name to backup (optional) If no collection name is provided, all collections will be backed up
  "docLimit": 1000 // Specify the maximum number of documents to backup per collection (optional), if not provided, all documents will be backed up (not having a limit might cause timeout for large collections)
}

새 컬렉션을 만드세요:

{
  "name": "products",
  "type": 2, // 2 for document collection, 3 for edge collection (optional, defaults to document collection)
  "waitForSync": false // Optional, defaults to false
}

디버깅

MCP 서버는 stdio를 통해 통신하므로 디버깅이 어려울 수 있습니다. 개발에는 MCP Inspector를 사용하는 것이 좋습니다.

npm run inspector

검사기는 브라우저에서 디버깅 도구에 액세스할 수 있는 URL을 제공합니다.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여되었습니다. 자세한 내용은 라이선스 파일을 참조하세요.

You must be authenticated.

A

security – no known vulnerabilities

A

license - permissive license

A

quality - confirmed to work

Tools

모델 컨텍스트 프로토콜을 사용하여 ArangoDB와 상호 작용하는 TypeScript 기반 서버로, Claude 및 VSCode 확장과 같은 도구와 통합하여 데이터베이스 작업을 수행하고 간소화된 데이터 관리를 가능하게 합니다.

Related Resources

Reddit Discussion about this server

MCP Server for ArangoDB