MCP Server Arangodb

🚀 ArangoDB MCP Server

A Model Context Protocol (MCP) server for ArangoDB.

This is a TypeScript-based MCP server that enables database interactions through ArangoDB. It implements core database operations and allows seamless integration with ArangoDB. When using MCP tools, it can be used in conjunction with the Claude application and the VSCode extension!

🚀 Quick Start

This is a TypeScript-based MCP server that provides the ability to interact with the database through ArangoDB. It implements core database operations and allows seamless integration with ArangoDB. When using MCP tools, it can be used with the Claude application and the VSCode extension!

✨ Features

Tools

• arango_query - Execute AQL queries

  • Accepts a required AQL query string parameter.
  • Optionally accepts binding variables for parameterized queries.
  • Returns the query results as JSON.

• arango_insert - Insert documents into a collection

  • Accepts a collection name and a required document parameter.
  • Supports an optional conditional operator conflictHandler, defaulting to "abort".

• arango_update - Update documents in a collection

  • Accepts a collection name, a required key, and update content.
  • Supports an optional conditional operator conflictHandler, defaulting to "abort".

• arango_remove - Delete documents from a collection

  • Accepts a collection name and a required key.

• arango_listCollections - List all collections

  • Returns a list of collections and their detailed information (ID, system flag).

• arango_backup - Backup collections in the database

  • Optionally specify an output directory, specific collections, or document limits.

• arango_createCollection - Create a new collection

  • Supports setting the collection type and the waitForSync flag.

📚 Documentation

Database Structure

This server is independent of the database structure and only needs to follow ArangoDB's document and edge collection models.

Development

Install Dependencies

npm install

Build

npm run build

Monitoring Task

npm run dev

Usage Instructions

Installation (Using Smithery CLI)

npx smithery install @ravenwits/mcp-server-arangodb@latest

Environment Variables

• URL: Set to the address of ArangoDB, defaulting to http://localhost:8529.
• DATABASE: Specify the database to connect to, defaulting to _system.
• USERNAME: Provide the username for connection.
• PASSWORD: Provide the corresponding password.

💻 Usage Examples

Backing up the Database

{
  "outputDir": "./backup", // Specify an absolute output directory path (optional).
  "collection": "users",    // Specify the name of the collection to back up (optional). If not specified, all collections will be backed up.
  "docLimit": 1000         // Set the maximum number of documents to back up per collection (optional). If not set, there is no limit.
}

Creating a New Collection

{
  "name": "products",
  "type": 2,             // Type: 2 represents a document collection, 3 represents an edge collection. The default is a document collection.
  "waitForSync": false    // Whether to wait for synchronization. The default is false.
}

Debugging

Since the MCP server communicates through standard input and output, debugging can be challenging. We recommend using MCP Inspector for development:

npm run inspector

The Inspector will provide a URL to access the debugging tool in the browser.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for specific details.