MCP Server (NestJS)

A robust, scalable, and extensible server-side application built with NestJS. This project provides a Model Context Protocol (MCP) server implementation, file management, authentication, and modular REST APIs for posts and users.

Table of Contents

• Features

• Architecture

• Getting Started

• Development

• Testing

• Deployment

• API Reference

• Project Structure

• Contributing

• License

Features

• MCP Server: Implements Model Context Protocol for file operations and more.

• File Management: Upload, download, list, and delete files via REST endpoints.

• Authentication: JWT-based authentication with local strategy.

• User & Post Modules: Modular structure for users and posts with DTOs and entities.

• Swagger Integration: API documentation out-of-the-box.

• Extensible: Easily add new modules and features.

Architecture

• NestJS: Progressive Node.js framework for building efficient, reliable, and scalable server-side applications.

• MCP Integration: Uses a custom FileBrowserMCP for file operations.

• Modular Design: Each feature is encapsulated in its own module.

Getting Started

Prerequisites

• Node.js (v18+ recommended)

• npm (comes with Node.js)

• Git

Installation

Environment Variables

Create a .env file in the root directory for any secrets or configuration overrides (optional).

Development

Running the Server

Useful Commands

Testing

Run Unit Tests

Run End-to-End (e2e) Tests

Test Coverage

Deployment

1. Build the project:

   $ npm run build

2. Start the server:

   $ npm run start:prod

3. For advanced deployment (Docker, cloud, etc.), see NestJS Deployment Docs.

API Reference

• Swagger UI is available (if enabled) at /api when the server is running.

• Main endpoints:

  • POST /auth/login — Authenticate and receive JWT

  • POST /files/upload — Upload a file

  • GET /files/:id — Download a file

  • DELETE /files/:id — Delete a file

  • GET /files — List files

  • POST /users — Create a user

  • POST /posts — Create a post

See controller files in src/ for more details.

Project Structure

Contributing

1. Fork the repository

2. Create your feature branch (git checkout -b feature/YourFeature)

3. Commit your changes (git commit -am 'Add some feature')

4. Push to the branch (git push origin feature/YourFeature)

5. Open a pull request

Coding Standards

• Follow the existing code style (see ESLint config)

• Write unit and e2e tests for new features

• Document your code and update the README as needed

Git Setup

This project uses Git for version control. The remote origin is set to:

License

Nest is MIT licensed.

Resources & Support

• NestJS Documentation

• Discord Community

• Courses

• NestJS Devtools

• Enterprise Support

• Jobs Board

• Author

For any questions, issues, or feature requests, please open an issue or contact the maintainer.