使用说明

项目简介

ArangoDB MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器，它允许大型语言模型（LLM）客户端通过标准化的 MCP 协议与 ArangoDB 数据库进行交互。该服务器提供了一系列工具，使 LLM 能够查询、插入、更新、删除 ArangoDB 数据库中的数据，以及管理数据库集合和备份数据。

主要功能点

数据查询: 执行 AQL (ArangoDB Query Language) 查询，检索数据库信息。
数据操作: 支持在 ArangoDB 数据库中插入、更新和删除文档数据。
集合管理: 允许列出和创建数据库集合。
数据备份: 可以将数据库集合备份为 JSON 文件。

安装步骤

安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm。
克隆仓库: 'git clone https://github.com/ravenwits/mcp-server-arangodb'
进入仓库目录: 'cd mcp-server-arangodb'
安装依赖: 'npm install'
构建项目: 'npm run build'

服务器配置

为了让 MCP 客户端（如 Claude 或 Cline）连接到 ArangoDB MCP Server，你需要在客户端的配置文件中添加服务器配置信息。以下是一个配置示例，你需要根据你的实际环境进行修改：

{
  "mcpServers": {
    "arangodb": {  // 服务器名称，可以自定义
      "command": "node",  // 启动服务器的命令，这里使用 Node.js 运行
      "args": ["/path/to/mcp-server-arangodb/build/index.js"], // 服务器启动脚本的路径，请替换为实际路径
      "env": {
        "ARANGO_URL": "http://localhost:8529",  // ArangoDB 服务器 URL，默认端口为 8529
        "ARANGO_DATABASE": "your_database_name", // 你要连接的 ArangoDB 数据库名称
        "ARANGO_USERNAME": "your_username",    // ArangoDB 数据库用户名
        "ARANGO_PASSWORD": "your_password"     // ArangoDB 数据库密码
      }
    }
  }
}

注意:

请将 '/path/to/mcp-server-arangodb/build/index.js' 替换为 'index.js' 文件在你的系统中的实际绝对路径。
请根据你的 ArangoDB 数据库配置，修改 'ARANGO_URL', 'ARANGO_DATABASE', 'ARANGO_USERNAME', 和 'ARANGO_PASSWORD' 环境变量的值。

基本使用方法

配置完成后，在 MCP 客户端中，你可以通过自然语言指令或结构化请求调用 ArangoDB MCP Server 提供的工具来操作 ArangoDB 数据库。例如，你可以使用类似以下的指令：

"列出所有数据库集合"
"查询所有用户"
"在 'users' 集合中插入一个新的用户文档，用户名为 '张三'，邮箱为 '[email protected]'"

关键词