nei

Provides tools to query NEI project data and keep local data synchronized with NEI backend.

typescript

0

GitHub Stars

typescript

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "leila-huang-nei-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@leila329/nei-mcp-server"
      ],
      "env": {
        "PROJECT_ID": "xxx",
        "SERVER_URL": "xxx"
      }
    }
  }
}

You run the nei MCP Server to interact with the NEI platform, exposing a set of MCP tools that let you quickly query project resources, search interfaces and groups, and keep local data in sync with the remote NEI backend. This server is designed to be run locally and connected to via an MCP client, making it easy to integrate NEI data into your workflows.

How to use

To use this MCP server, run it through an MCP client by providing its runtime command and arguments. You can start the server locally and then query NEI project resources through the exposed tools. The server supports a stdio-based startup via an MCP runner, which means you can execute it as a local process and pass in environment variables for SERVER_URL and PROJECT_ID. Use the client’s interface to pick a tool, supply any required parameters, and receive results from NEI without manual HTTP calls.

How to install

Prerequisites you need on your system before installation:

Node.js (recommended version 20 or newer)
pnpm (optional, recommended)

How to install

git clone https://github.com/leila-huang/nei-mcp-server.git
cd nei-mcp-server
npm install
# or, if you prefer using pnpm
pnpm install

How to run the MCP client with this server

{
  "mcpServers": {
      "nei_mcp": {
          "command": "npx",
          "args": ["-y", "@leila329/nei-mcp-server"],
          "env": {
              "SERVER_URL": "xxx",
              "PROJECT_ID": "xxx"
          }
      }
  }
}

Usage via an MCP client example

{
  "mcpServers": {
      "nei_mcp": {
          "command": "npx",
          "args": [
              "-y",
              "@leila329/nei-mcp-server"
          ],
          "env": {
              "SERVER_URL": "xxx",
              "PROJECT_ID": "xxx"
          }
      }
  }
}

Caching and synchronization notes

A simple in-memory cache stores data after the first load to improve response times. On service startup or when you run the sync tool, the server fetches the latest project data from NEI and updates the in-memory cache. This helps you work with fresh data while reducing load on the NEI backend.

Available tools

sync_nei_project

Forces a remote synchronization to fetch the latest NEI project data and refreshes the local cache so you have up-to-date models and interfaces.

search_interfaces_by_uri

Searches NEI project interfaces by a URI path using fuzzy matching to find relevant interfaces.

search_interfaces_by_name

Searches NEI project interfaces by name using fuzzy matching to locate interfaces by their names.

search_groups_by_name

Searches NEI project business groups by their names to help you locate related resources quickly.