MCP Nest

🚀 NestJS MCP Module

NestJS MCP Module is a powerful tool that allows you to integrate MCP functionality into your NestJS applications. It simplifies the process of setting up and managing MCP servers, providing a seamless experience for developers.

🚀 Quick Start

To start using the NestJS MCP Module, follow these steps:

📦 Installation

Install the module via npm or yarn:

npm install @rekog/mcp-nest
# or
yarn add @rekog/mcp-nest

🌟 Initialize the MCP Server

Initialize the MCP server in your NestJS application:

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

@Module({
  imports: [
    McpModule.forRoot({
      name: 'my-mcp-server',
      version: '1.0.0',
    }),
  ],
})
export class AppModule {}

📦 Installation and Configuration

📥 Installation

npm install @rekog/mcp-nest
# or
yarn add @rekog/mcp-nest

⚙️ Configuration

Import the module in app.module.ts:

import { McpModule } from '@rekog/mcp-nest';

💻 Usage Examples

📝 Basic Usage

Create a tool:

import { McpTool, McpContext } from '@rekog/mcp-nest';

export class MyAwesomeTool implements McpTool {
  async execute(context: McpContext): Promise<void> {
    // Implement your tool logic here
  }
}

Register the tool:

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

@Module({
  imports: [
    McpModule.forRoot({
      name: 'my-mcp-server',
      version: '1.0.0',
    }),
  ],
})
export class AppModule {}

🏗️ Playground

The playground directory contains examples for quickly testing the functionality of MCP and @rekog/mcp-nest. Refer to playground/README.md for more details.

⚙️ Configuration Options

The McpModule.forRoot() method accepts an McpOptions object to configure the server. Here are the available options:

🔧 Interceptors

🛠️ Create an Interceptor

import { McpInterceptor } from '@rekog/mcp-nest';

export class MyAwesomeInterceptor implements McpInterceptor {
  intercept(context: any, next: Function): any {
    // Implement your interception logic here
    return next();
  }
}

📝 Register the Interceptor

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

@Module({
  imports: [
    McpModule.forRoot({
      name: 'my-mcp-server',
      version: '1.0.0',
    }),
  ],
})
export class AppModule {}

🛠️ Development Guide

🛠️ Create a Tool

import { McpTool, McpContext } from '@rekog/mcp-nest';

export class HelloTool implements McpTool {
  async execute(context: McpContext): Promise<void> {
    await context.send('Hello, World!');
  }
}

📝 Register the Tool

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

@Module({
  imports: [
    McpModule.forRoot({
      name: 'my-mcp-server',
      version: '1.0.0',
      tools: [HelloTool],
    }),
  ],
})
export class AppModule {}

🛠️ Create an Interceptor

import { McpInterceptor } from '@rekog/mcp-nest';

export class LoggingInterceptor implements McpInterceptor {
  intercept(context: any, next: Function): any {
    console.log('Request started');
    const result = next();
    console.log('Request ended');
    return result;
  }
}

📝 Register the Interceptor

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

@Module({
  imports: [
    McpModule.forRoot({
      name: 'my-mcp-server',
      version: '1.0.0',
      interceptors: [LoggingInterceptor],
    }),
  ],
})
export class AppModule {}

📚 Documentation

For detailed documentation, visit the Official Documentation of NestJS MCP Module.

👨‍💻 Maintainers

• Your Name

📄 License

This project is open-source under the MIT License.