@gurusharan3107/mcp-knowledge-graph NPM

MCP Server for Knowledge Graph

This project implements a standalone MCP (Model Context Protocol) server focused on knowledge graph tools. It provides a standardized interface for AI clients or any MCP-enabled application to create, query, and manipulate entities and relationships within a persistent knowledge graph. This graph can represent codebases, research projects, or any other domain where structured, persistent knowledge is beneficial. The goal is to provide a robust external memory and context mechanism across sessions.

Features

Modular architecture with clear separation of concerns
Standalone Express server mode for direct integration with various host applications
NextJS API route compatibility for potential web integration (e.g., for a UI)
Core knowledge graph tools for entity, relationship, and observation management
Session management for maintaining client context (potentially using project identifiers or paths)
Persistent storage using KuzuDB

Installation

Clone the repository (if you haven't already):

git clone <your-repository-url>
cd mcp-knowledge-graph

Install dependencies:
```
npm install
```
Prepare the application (builds server and Next.js app): This step compiles the TypeScript server code to JavaScript (in dist/) and builds the Next.js application for production (in .next/).
```
npm run preparepackage
```

Running the Project

You can run the project in two modes: development and production.

Development Mode

In development mode, you'll have two services running concurrently:

Next.js Development Server (UI): Serves the frontend application with hot-reloading.
- Runs on: http://localhost:4000
API Server (standalone-server.ts): Handles backend API logic.
- Runs on: http://localhost:3155

The Next.js development server is configured to proxy API requests (/api/ui/*) from the UI (port 4000) to the API server (port 3155).

To start in development mode:

npm run start:all

Access the UI in your browser at http://localhost:4000.

Production Mode

In production mode, a single server process (started from dist/standalone-server.js) handles both the API requests and serves the optimized Next.js UI.

Combined UI and API Server:
- Runs on: http://localhost:4000 (this is configurable via the UI_API_PORT environment variable in the start:prod script).

Prerequisites: Ensure you have built the application using npm run preparepackage.

To start in production mode:

npm run start:prod

Access the UI in your browser at http://localhost:4000.

MCP SDK Server (Stdio)

In both development and production modes, the main Node.js server process (standalone-server.ts or its compiled version in dist/) also initializes and runs the MCP SDK server. This server communicates over stdio by default and is intended for programmatic interaction by MCP-compatible clients (like an AI model host). It does not use a separate HTTP port unless configured differently within the MCP SDK setup.

Configuration

Host Application Configuration

To integrate this server with an MCP-compatible host application, you typically need to configure the host to launch the standalone server. The specific configuration method depends on the host application. Below is a generic example inspired by common patterns:

{
  "mcpServers": {
    "knowledge-graph-server-id": { // An identifier used by the host application
      "command": "node", // Or the path to the node executable
      "args": [
        // Ensure this is the *absolute path* to the built standalone server file
        "/path/to/your/mcp-knowledge-graph/dist/standalone-server.js"
        // Optional: Additional arguments for the server can be added here
      ],
      // Optional: Specify communication method (e.g., port, stdio) if needed by the host
      "port": 3001 // Example if communicating via network port
    }
    // ... potentially other MCP server configurations ...
  }
}

Consult the documentation of your specific host application to determine the correct way to register and configure an external MCP server. Make sure the command and args correctly point to your Node executable and the absolute path to the compiled standalone-server.js.

Architecture

The server follows a modular architecture:

Core Components:
- MCPServer: Handles MCP protocol logic, connection management, and tool dispatch.
- Tool Handlers: Implement the logic for each specific MCP tool.
Data Layer:
- KuzuDB: An embedded graph database used for persistent storage of entities, relationships, and observations. This allows the knowledge graph to survive server restarts.
Transport Layer:
- Handles communication (e.g., Stdio, HTTP/SSE) between the server and the MCP client. Configured during server setup.
(Optional) UI:
- A potential Next.js frontend (running separately, e.g., on port 3000) could be developed to visualize the graph and allow manual interaction, interacting with the server via its API routes or potentially MCP itself if configured.

Available Tools

The server focuses on providing tools for knowledge graph manipulation:

Entity Management: create_entity, get_entity, list_entities, update_entity_description, delete_entity
Relationship Management: create_relationship, get_relationships, get_related_entities, delete_relationship
Observation Management: add_observation, delete_observation

(Detailed specifications for these tools can be found in docs/implementation-plan.md)

Known Issues

Port Conflict (EADDRINUSE) on Restart: Sometimes, when the host application is closed, it may not correctly terminate the standalone server process it launched. This leaves the communication port (e.g., 3001) occupied. When the host application restarts, it might try to start the server again on the same port, resulting in an "address already in use" error.
- Workaround 1: Manually find and terminate the lingering node process associated with standalone-server.js using your system's activity monitor or command-line tools (lsof -ti tcp:<PORT>, then kill <PID>) before restarting the host application. Proper termination should ideally be handled by the host application's lifecycle management.
- Workaround 2: Change the default port in standalone-server.ts (if configurable, check the source) or configure the server to use a different port via arguments if supported. Rebuild the server (npm run build:server or similar) and update the host application configuration accordingly.

Development

Directory Structure

├── app/                  # Optional NextJS app directory (e.g., for UI)
│   └── api/              # API routes
│       └── mcp/          # MCP API route
├── lib/                  # Library code
│   └── mcp/              # MCP implementation
│       ├── tools/        # Tool implementations
│       └── transport/    # Transport implementations
├── dist/                 # Compiled output
├── setup.js              # Setup script for standalone server
└── standalone-server.js  # Standalone Express server

Adding New Tools

To add new tools, create a new tool configuration in the lib/mcp/tools directory following the pattern of the existing tools. Then register the tool configuration in the server configuration.

5 months ago

5 months ago

5 months ago

5 months ago