What is Marklogic Mcp

marklogic-mcp is a Model Context Protocol (MCP) server implementation for MarkLogic, enabling interaction with a MarkLogic database through various MCP tools.

Use cases

Use cases for marklogic-mcp include managing digital assets, implementing document workflows, conducting data analysis, and integrating with other applications that require access to a MarkLogic database.

How to use

To use marklogic-mcp, install it via pip with ‘pip install mcp-marklogic’, configure the necessary environment variables, and start the server using ‘mcp-marklogic’. You can then utilize available tools to create, read, delete, and search documents in MarkLogic.

Key features

Key features include the ability to create documents with optional collections, read documents by URI, delete documents by URI, and search documents using query strings with optional collection filters.

Where to use

marklogic-mcp can be used in various fields that require document management and database interactions, such as content management systems, data integration platforms, and enterprise applications.

MCP MarkLogic Server

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

2. The server provides the following operations:

Create Document

• Create documents in MarkLogic with optional collections
• Read documents by URI
• Delete documents by URI
• Search documents with query strings and optional collection filters

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

Once installed and configured, 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)

Development

Setup

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

   pip install -e .
   

Running Tests

pytest tests/

MarkLogic Setup

1. Ensure you have MarkLogic Server installed and running
2. Create a REST API instance on port 8000 if not already present
3. Create a user with appropriate permissions:
   • Go to Admin Interface (usually http://localhost:8001)
   • Create role python-docs-role with:
     • Roles: rest-extension-user, rest-reader, rest-writer
     • Privileges: xdbc:eval, xdbc:invoke, xdmp:eval-in
   • Create user python-user with:
     • Password: pyth0n
     • Role: python-docs-role

License

MIT