Marklogic MCP

🚀 MCP MarkLogic Server

This is a Model Context Protocol (MCP) server implemented for MarkLogic, allowing you to interact with the MarkLogic database through MCP tools.

🚀 Quick Start

This MCP server for MarkLogic enables seamless interaction with the MarkLogic database using MCP tools.

📦 Installation

pip install mcp-marklogic

📚 Configuration

The server requires the following environment variables:

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

💻 Usage Examples

Basic Usage

After installation, you can start the server:

mcp-marklogic

Available Tools

1. create-document

   • Create a new document in MarkLogic.
   • Parameters:
     • uri: Document URI (required).
     • content: Document content as JSON (required).
     • collections: List of collections to add the document to (optional).

2. read-document

   • Read a document from MarkLogic.
   • Parameters:
     • uri: Document URI (required).

3. delete-document

   • Delete a document from MarkLogic.
   • Parameters:
     • uri: Document URI (required).

4. search-documents

   • Search for documents in MarkLogic.
   • Parameters:
     • query: Search query string (required).
     • collections: List of collections to search in (optional).

🔧 Technical Details

Setup

1. Clone the repository.
2. Create and activate a virtual environment.
3. Install the dependencies:

pip install -e .

Running Tests

pytest tests/

MarkLogic Setup

1. Ensure that the MarkLogic server is installed and running.
2. Create a REST API instance on port 8000 if it doesn't exist.
3. Create a user with appropriate permissions:
   • Access the management interface (usually http://localhost:8001).
   • Create a role python-docs-role with the following settings:
     • Roles: rest-extension-user, rest-reader, rest-writer.
     • Privileges: xdbc:eval, xdbc:invoke, xdmp:eval-in.
   • Create a user python-user with the following settings:
     • Password: pyth0n.
     • Roles: python-docs-role.

📄 License

MIT