Marklogic MCP

🚀 MCP MarkLogic 服務器

這是一個專為 MarkLogic 實現的 Model Context Protocol (MCP) 服務器，藉助該服務器，您能夠通過 MCP 工具與 MarkLogic 數據庫進行交互，為數據操作提供便利。

🚀 快速開始

安裝完成後，您可以啟動服務器：

mcp-marklogic

✨ 主要特性

• 支持通過 MCP 工具與 MarkLogic 數據庫交互。
• 提供了創建、讀取、刪除和搜索文檔等常用操作工具。

📦 安裝指南

安裝依賴

pip install mcp-marklogic

配置環境變量

服務器需要以下環境變量：

MARKLOGIC_HOST=localhost
MARKLOGIC_PORT=8000
MARKLOGIC_USERNAME=admin
MARKLOGIC_PASSWORD=admin

💻 使用示例

可用工具

1. create-document

   • 功能：在 MarkLogic 中創建新文檔
   • 參數：
     • uri：文檔 URI（必需）
     • content：文檔內容作為 JSON（必需）
     • collections：要添加到其中的集合列表（可選）

2. read-document

   • 功能：從 MarkLogic 讀取文檔
   • 參數：
     • uri：文檔 URI（必需）

3. delete-document

   • 功能：從 MarkLogic 刪除文檔
   • 參數：
     • uri：文檔 URI（必需）

4. search-documents

   • 功能：在 MarkLogic 中搜索文檔
   • 參數：
     • query：搜索查詢字符串（必需）
     • collections：要搜索的集合列表（可選）

📚 詳細文檔

開發設置

1. 克隆倉庫
2. 創建虛擬環境並激活它
3. 安裝依賴項：

pip install -e .

運行測試

pytest tests/

MarkLogic 設置

1. 確保已經安裝並運行了 MarkLogic 服務器
2. 如果尚未存在，請在端口 8000 上創建一個 REST API 實例
3. 創建具有適當權限的用戶：
   • 訪問管理界面（通常為 http://localhost:8001）
   • 創建角色 python-docs-role，具有以下設置：
     • 角色：rest-extension-user, rest-reader, rest-writer
     • 特權：xdbc:eval, xdbc:invoke, xdmp:eval-in
   • 創建用戶 python-user，具有以下設置：
     • 密碼：pyth0n
     • 角色：python-docs-role

📄 許可證

本項目採用 MIT 許可證。