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 许可证。