nei-mcp-server

A tool server based on fastmcp for interacting with the NEI platform, providing the ability to query NEI project resources.

Core Features

This project encapsulates common NEI platform functions into a series of MCP tools for quick querying and integration. The supported tools are as follows:

• sync_nei_project: Force synchronization of the latest project data from the remote NEI platform and update the local cache. This tool should be called first when you suspect local data is not up to date or when you need to retrieve recently changed backend interface or data model information.

• search_interfaces_by_uri: Fuzzy search for interface resources in the NEI project based on the interface definition URI (interface path).

• search_interfaces_by_url: Precisely search for interface resources based on the pid and id in the NEI interface detail link, for example http://nei.example.com/interface/detail/?pid=10135&id=13015.

• search_interfaces_by_name: Fuzzy search for interface resources in the NEI project based on the interface name.

• search_groups_by_name: Search for business groups in the NEI project based on the group name.

Related MCP server: YApi MCP Server

Environment Preparation

• Node.js (v20 or higher recommended)

• pnpm (optional, recommended)

Installation and Configuration

1. Clone the project

   git clone https://github.com/leila-huang/nei-mcp-server.git
   cd nei-mcp-server

2. Install dependencies Using npm:

   npm install

   Or pnpm:

   pnpm install

Debugging Tools

1. inspect debugging Using the inspect command of fastmcp allows for convenient interactive testing of all tools locally. You need to configure SERVER_URL and PROJECT_ID on the web page.

   npm run inspect

   This command provides an interactive interface where you can select the tool to execute and input parameters, which is very suitable for debugging and exploration.

2. mcp client debugging

       {
         "mcpServers": {
             "nei-mcp-server": {
                 "command": "npx",
                 "args": ["tsx", "/PATH/TO/YOUR_PROJECT/src/index.ts"],
                 "env": {
                     "SERVER_URL": "xxx",
                     "PROJECT_ID": "xxx"
                 }
             }
         }
       }

mcp User Guide

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

Caching Mechanism

To improve performance and reduce the request load on the NEI server, this project implements a simple caching strategy:

1. Memory Caching: Data is stored in memory after the first load. During a single run of the service, subsequent identical requests will be returned directly from memory, avoiding redundant network requests. The memory cache is cleared after the service restarts.

2. Network Synchronization: When the service starts, or when the sync_nei_project tool is called manually, the latest project data is pulled from the remote NEI server and the memory cache is updated.

You can manually trigger a network synchronization by calling the sync_nei_project tool to ensure the data is the latest version.