MCP Server Arangodb

🚀 ArangoDBのMCPサーバ

ArangoDB用のモデルコンテキストプロトコル (MCP) サーバです。

これはTypeScriptベースのMCPサーバで、ArangoDBを通じたデータベースとのやり取り機能を提供します。核心的なデータベース操作を実装し、ArangoDBとシームレスに統合できます。MCPツールを使用する際には、ClaudeアプリケーションやVSCode拡張機能と一緒に利用できます！

✨ 主な機能

ツール

• 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

環境変数

• URL：ArangoDBのアドレスに設定します。デフォルトは http://localhost:8529 です。
• DATABASE：接続するデータベースを指定します。デフォルトは _system です。
• USERNAME：接続に使用するユーザー名を提供します。
• PASSWORD：対応するパスワードを提供します。

データベースのバックアップ

{
  "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 ファイルを参照してください。