MCP-сервер (NestJS)

Надежное, масштабируемое и расширяемое серверное приложение, созданное с помощью NestJS . Этот проект обеспечивает реализацию сервера Model Context Protocol (MCP), управление файлами, аутентификацию и модульные REST API для постов и пользователей.

Оглавление

• Функции

• Архитектура

• Начиная

• Разработка

• Тестирование

• Развертывание

• Ссылка на API

• Структура проекта

• Внося вклад

• Лицензия

Related MCP server: File Operations MCP Server

Функции

• Сервер MCP : реализует протокол контекста модели для файловых операций и многого другого.

• Управление файлами : загрузка, скачивание, составление списков и удаление файлов через конечные точки REST.

• Аутентификация : аутентификация на основе JWT с локальной стратегией.

• Модули пользователей и сообщений : модульная структура для пользователей и сообщений с DTO и сущностями.

• Интеграция Swagger : готовая документация API.

• Расширяемость : легко добавляйте новые модули и функции.

Архитектура

• NestJS : прогрессивная платформа Node.js для создания эффективных, надежных и масштабируемых серверных приложений.

• Интеграция MCP : использует пользовательский FileBrowserMCP для файловых операций.

• Модульная конструкция : каждая функция заключена в отдельный модуль.

Начиная

Предпосылки

• Node.js (рекомендуется v18+)

• npm (входит в состав Node.js)

• Гит

Установка

Переменные среды

Создайте файл .env в корневом каталоге для любых секретов или переопределений конфигурации (необязательно).

Разработка

Запуск сервера

Полезные команды

Тестирование

Запуск модульных тестов

Проведение сквозных (e2e) тестов

Тестовое покрытие

Развертывание

1. Создайте проект:

   $ npm run build

2. Запустите сервер:

   $ npm run start:prod

3. Для расширенного развертывания (Docker, облако и т. д.) см. документацию по развертыванию NestJS .

Ссылка на API

• Пользовательский интерфейс Swagger доступен (если включен) в /api , когда сервер запущен.

• Основные конечные точки:

  • POST /auth/login — Аутентификация и получение JWT

  • POST /files/upload — Загрузить файл

  • GET /files/:id — Загрузить файл

  • DELETE /files/:id Удалить файл

  • GET /files — Список файлов

  • POST /users — Создать пользователя

  • POST /posts — Создать пост

Более подробную информацию смотрите в файлах контроллера в src/ .

Структура проекта

Внося вклад

1. Форк репозитория

2. Создайте ветку функций ( git checkout -b feature/YourFeature )

3. Зафиксируйте свои изменения ( git commit -am 'Add some feature' )

4. Отправка в ветку ( git push origin feature/YourFeature )

5. Откройте запрос на извлечение

Стандарты кодирования

• Следуйте существующему стилю кода (см. конфигурацию ESLint)

• Написание модульных и e2e-тестов для новых функций

• Документируйте свой код и при необходимости обновляйте README.

Настройка Git

Этот проект использует Git для контроля версий. Удаленный источник установлен на:

Лицензия

Nest имеет лицензию MIT .

Ресурсы и поддержка

• Документация NestJS

• Сообщество Discord

• Курсы

• Инструменты разработчика NestJS

• Поддержка предприятий

• Совет по трудоустройству

• Автор

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