Skip to content

Latest commit

 

History

History
161 lines (118 loc) · 3.96 KB

File metadata and controls

161 lines (118 loc) · 3.96 KB

MCP Server for ldbc (Lepus Database Connectivity) Document

ldbc

Continuous Integration MIT License Typelevel Affiliate Project npm version

A Model Context Protocol server that provides access to ldbc documents. This server allows the LLM to inspect ldbc documents, answer questions, and perform tutorials.

2025-04-25.22.13.51.mov

Installation

There are several ways to install and configure the MCP server:

Visual Studio Code

To manually configure the MCP server for Visual Studio Code, add the following to your settings.json file (usually located in your user directory)

{
    "files.autoSave": "afterDelay",
    "mcp": {        
        "inputs": [],
        "servers": {
            "mcp-ldbc-document-server": {
                "command": "npx",
                "args": [
                    "@ldbc/mcp-document-server"
                ],
                "env": {}
            }
        }
    }
}

Claude Desktop

To manually configure the MCP server for Claude Desktop App, add the following to your claude_desktop_config.json file (typically located in your user directory):

{
  "mcpServers": {
    "mcp-ldbc-document-server": {
      "command": "npx",
      "args": [
        "@ldbc/mcp-document-server"
      ],
      "env": {}
    }
  }
}

Using NPM/PNPM

For manual installation:

# Using npm
npm install -g @ldbc/mcp-document-mysql

# Using pnpm
pnpm add -g @ldbc/mcp-document-mysql

After manual installation, you'll need to configure your LLM application to use the MCP server (see Configuration section below).

Running from Local Repository

If you want to clone and run this MCP server directly from the source code, follow these steps:

  1. Clone the repository
git clone [email protected]:takapi327/ldbc.git
  1. Install dependencies
npm install
# or
pnpm install
  1. Build the project
sbt docs/tlSite
sbt mcpDocumentServer/npmPackage
  1. Configure Visual Studio Code

Add the following to the Visual Studio Code settings file (settings.json)

{
    "files.autoSave": "afterDelay",
    "mcp": {        
        "inputs": [],
        "servers": {
            "mcp-ldbc-document-server": {
                "command": "/path/to/node",
                "args": [
                    "/full/path/to/ldbc/mcp/document-server/.js/target/scala-x.x.x/npm-package/main.js"
                ],
                "env": {}
            }
        }
    }
}

Replace:

  • /path/to/node with the full path to your Node.js binary (find it with which node)
  • /full/path/to/ldbc/mcp/document-server/... with the full path to where you cloned the repository

Local Setup

Use verdaccio for local verification.

First, start verdaccio using docker.

docker compose up -d

After startup, users are created using the verdaccio server port. (* First time startup only)

npm adduser --registry http://localhost:4873

Then enter your username, password, and email address.

Build the code.

sbt mcpDocumentServer/npmPackage
sbt mcpDocumentServer/npmPackageNpmrc

Go to the generated npm-package directory.

cd mcp/document-server/.js/target/scala-x.x.x/npm-package

Upload against verdaccio.

npm publish --registry http://localhost:4873