ArangoDB MCP Server 使用说明

项目简介

ArangoDB MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它允许大型语言模型 (LLM) 客户端以标准化的方式与 ArangoDB 数据库进行交互。通过此服务器，LLM 可以执行查询、检索数据，并将 ArangoDB 作为其上下文信息来源。

主要功能点

资源管理: 将 ArangoDB 数据库中的集合 (Collections) 暴露为 MCP 资源，允许 LLM 客户端发现和访问这些资源。
工具集成: 提供了一系列工具，例如：
- 'readQuery': 执行只读的 ArangoDB 查询语言 (AQL) 查询。
- 'readWriteQuery': 执行可读写的 AQL 查询。
- 'listDatabases': 列出 ArangoDB 服务器上的所有数据库。
- 'listCollections': 列出指定数据库中的所有集合。
标准 MCP 协议: 完全遵循 Model Context Protocol 规范，使用 JSON-RPC over Stdio 进行通信。
灵活配置: 支持通过命令行参数配置 ArangoDB 连接信息，包括服务器 URL、用户名和密码。

安装步骤

克隆仓库:

git clone https://github.com/lucas-deangelis/arango-mcp-server
cd arango-mcp-server

安装依赖: 确保你已安装 Node.js 和 npm。在项目根目录下运行：
```
npm install
```

服务器配置

要将 ArangoDB MCP Server 集成到 MCP 客户端（例如 Claude），你需要在客户端的配置文件中添加 MCP 服务器的配置信息。以下是一个 'claude_desktop_config.json' 示例，你需要根据你的实际 ArangoDB 环境进行修改。

{
  "mcpServers": {
    "arangodb-mcp": {  // 服务器名称，可以自定义
      "command": "npx",
      "args": [
        "-y",
        "arango-mcp-server", // 启动命令，指向 arango-mcp-server
        "http://localhost:8529", // ArangoDB 服务器的 URL 地址，请替换为你的 ArangoDB 服务器地址
        "root",                 // ArangoDB 用户名 (如果需要身份验证，否则可以省略)
        "root"                  // ArangoDB 密码 (如果需要身份验证，否则可以省略)
      ]
    }
  }
}

参数说明:

'command': 指定启动 MCP 服务器的命令，这里使用 'npx' 来运行本地安装的 'arango-mcp-server' 包。
'args': 传递给 'arango-mcp-server' 命令的参数：
- '"-y"': 'npx' 的参数，用于自动确认安装 'arango-mcp-server' 包（如果尚未安装）。
- '"arango-mcp-server"': 要执行的 npm 包名，对应项目 package.json 中的 'name' 字段。
- '"http://localhost:8529"': ArangoDB 服务器的 URL 地址，请根据你的 ArangoDB 服务器配置进行修改。
- '"root"' (可选): ArangoDB 用户名，如果你的 ArangoDB 服务器需要身份验证，请提供有效的用户名。
- '"root"' (可选): ArangoDB 密码，如果你的 ArangoDB 服务器需要身份验证，请提供对应的密码。

基本使用方法

确保 ArangoDB 服务器已启动并可访问。
启动 ArangoDB MCP Server。通常情况下，当 MCP 客户端连接时，服务器会自动启动。你也可以在项目目录下手动运行 'npm run dev' 或 'npm start' (取决于你的环境和 package.json 配置)。
在你的 MCP 客户端中配置并连接到名为 'arangodb-mcp' (或你在 'claude_desktop_config.json' 中自定义的服务器名称) 的 MCP 服务器。
使用 MCP 客户端的功能，例如工具调用，来执行 ArangoDB 相关的操作，如查询数据、列出集合等。具体的工具和资源使用方法请参考 MCP 客户端的文档。

注意: 此 ArangoDB MCP Server 主要通过标准输入/输出 (stdio) 与 MCP 客户端通信。确保你的 MCP 客户端支持 stdio 传输协议。

关键词