nei-mcp-server

Инструментальный сервер на базе fastmcp для взаимодействия с платформой NEI, предоставляющий возможности запроса ресурсов проектов NEI.

Основные функции

Данный проект инкапсулирует часто используемые функции платформы NEI в набор инструментов MCP для быстрого поиска и интеграции. Поддерживаются следующие инструменты:

• sync_nei_project: принудительная синхронизация актуальных данных проекта с удаленной платформы NEI и обновление локального кэша. Этот инструмент следует вызывать в первую очередь, если есть подозрение, что локальные данные устарели, или если необходимо получить информацию о недавно измененных серверных интерфейсах или моделях данных.

• search_interfaces_by_uri: нечеткий поиск интерфейсных ресурсов в проекте NEI по URI (пути интерфейса).

• search_interfaces_by_url: точный поиск интерфейсных ресурсов по pid и id из ссылки на детали интерфейса NEI, например http://nei.example.com/interface/detail/?pid=10135&id=13015.

• search_interfaces_by_name: нечеткий поиск интерфейсных ресурсов в проекте NEI по имени интерфейса.

• search_groups_by_name: поиск бизнес-групп в проекте NEI по имени группы.

Related MCP server: Nexus MCP Server

Подготовка окружения

• Node.js (рекомендуется v20 или выше)

• pnpm (опционально, рекомендуется)

Установка и настройка

1. Клонирование проекта

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

2. Установка зависимостей Используя npm:

   npm install

   Или pnpm:

   pnpm install

Инструменты отладки

1. Отладка через inspect Использование команды inspect из fastmcp позволяет удобно тестировать все инструменты локально в интерактивном режиме. Необходимо настроить SERVER_URL и PROJECT_ID на веб-странице.

   npm run inspect

   Эта команда предоставляет интерактивный интерфейс, в котором можно выбирать инструменты для выполнения и вводить параметры, что отлично подходит для отладки и изучения.

2. Отладка через клиент mcp

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

Руководство по использованию mcp

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

Механизм кэширования

Для повышения производительности и снижения нагрузки на сервер NEI в проекте реализована простая стратегия кэширования:

1. Кэширование в памяти: данные сохраняются в памяти после первой загрузки. Во время одного сеанса работы службы последующие идентичные запросы будут возвращаться напрямую из памяти, что позволяет избежать повторных сетевых запросов. После перезапуска службы кэш в памяти очищается.

2. Сетевая синхронизация: при запуске службы или при ручном вызове инструмента sync_nei_project происходит получение актуальных данных проекта с удаленного сервера NEI и обновление кэша в памяти.

Вы можете вручную принудительно запустить сетевую синхронизацию, вызвав инструмент sync_nei_project, чтобы убедиться, что данные являются актуальными.