MCP Server Arangodb

🚀 ArangoDB 的 MCP 服務器

一個用於 ArangoDB 的模型上下文協議 (MCP) 服務器，基於 TypeScript 構建，能通過 ArangoDB 進行數據庫交互。它實現了核心數據庫操作，可與 ArangoDB 無縫集成，在使用 MCP 工具時，還能配合 Claude 應用和 VSCode 擴展一起使用！

🚀 快速開始

本項目是基於 TypeScript 的 MCP 服務器，可與 ArangoDB 無縫集成，實現數據庫交互。你可以按照以下步驟進行安裝和使用。

✨ 主要特性

工具

• arango_query - 執行 AQL 查詢

  • 接受一個必需的 AQL 查詢字符串參數。
  • 可選地接受綁定變量以實現參數化查詢。
  • 返回查詢結果作為 JSON。

• arango_insert - 向集合插入文檔

  • 接收集合名稱和必需的文檔參數。
  • 支持可選的條件操作符 conflictHandler，默認為 "abort"。

• arango_update - 更新集合中的文檔

  • 接收集合名稱、必需的鍵和更新內容。
  • 支持可選的條件操作符 conflictHandler，默認為 "abort"。

• arango_remove - 刪除集合中的文檔

  • 接收集合名稱和必需的鍵。

• arango_listCollections - 列出所有集合

  • 返回集合列表及其詳細信息（ID、系統標誌）。

• arango_backup - 備份數據庫中的集合

  • 可選地指定輸出目錄、特定集合或文檔限制。

• arango_createCollection - 創建新集合

  • 支持設置集合類型和 waitForSync 標誌。

🔧 技術細節

數據庫結構

該服務器與數據庫結構無關，只需遵循 ArangoDB 的文檔和邊收藏模型即可。

📦 安裝指南

開發環境安裝依賴

npm install

構建項目

npm run build

監控任務

npm run dev

安裝（使用 Smithery CLI）

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

環境變量

💻 使用示例

基礎用法

備份數據庫

{
  "outputDir": "./backup", // 指定一個絕對輸出目錄路徑（可選）
  "collection": "users",    // 指定要備份的集合名稱（可選），不指定則備份所有集合
  "docLimit": 1000         // 設置每個集合備份的最大文檔數（可選），不設置則不限制
}

創建新集合

{
  "name": "products",
  "type": 2,             // 類型：2 表示文檔集合，3 表示邊集合，默認為文檔集合
  "waitForSync": false    // 是否等待同步，默認為 false
}

📚 詳細文檔

調試

由於 MCP 服務器通過標準輸入輸出進行通信，調試可能具有一定挑戰性。我們推薦使用 MCP Inspector 進行開發：

npm run inspector

Inspector 將提供一個 URL，用於在瀏覽器中訪問調試工具。

📄 許可證

本項目採用 MIT 許可證，具體細節請參閱 LICENSE 文件。