πŸš€ Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more β†’
Socket
DemoInstallSign in
Socket

@orbit-codes/nestjs-mcp

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@orbit-codes/nestjs-mcp

A NestJS package to integrate MCP

1.0.15
latest
Source
npm
Version published
Weekly downloads
10
-84.85%
Maintainers
1
Weekly downloads
Β 
Created
Source

NestJS MCP Package

A NestJS integration for the Model Context Protocol (MCP), allowing you to easily create MCP servers with NestJS's dependency injection and decorator-based architecture.

Installation

npm install nestjs-mcp @modelcontextprotocol/sdk zod

Features

  • πŸš€ Seamless integration with NestJS using decorators
  • πŸ› οΈ Expose MCP resources, tools, and prompts with simple annotations
  • πŸ”„ Support for both HTTP/SSE and stdio transports
  • πŸ“¦ Compatible with both ESM and CommonJS
  • 🧩 Dynamic module configuration
  • βœ… Well-tested and production-ready

Quick Start

Register the Module

import { Module } from '@nestjs/common';
import { MCPModule } from 'nestjs-mcp';

@Module({
  imports: [
    MCPModule.register({
      name: 'MyMCPServer',
      version: '1.0.0',
      // Optional configuration
      sseEndpoint: '/mcp/sse',
      messagesEndpoint: '/mcp/messages',
      globalApiPrefix: '/api',
      capabilities: {
        // Your server capabilities
      },
    }),
  ],
})
export class AppModule {}

Create Resources

import { Injectable } from '@nestjs/common';
import { Resource } from 'nestjs-mcp';

@Injectable()
export class UsersService {
  private users = [
    { id: '1', name: 'John Doe', email: 'john@example.com' },
    { id: '2', name: 'Jane Smith', email: 'jane@example.com' },
  ];

  @Resource({
    name: 'users',
    description: 'Access user information',
    parameters: {
      id: 'string',
    },
  })
  async getUser(uri, params) {
    const { id } = params;
    const user = this.users.find(u => u.id === id);
    
    if (!user) {
      throw new Error(`User with ID ${id} not found`);
    }
    
    return {
      uri: uri.href,
      text: JSON.stringify(user),
    };
  }
}

Create Tools

import { Injectable } from '@nestjs/common';
import { Tool } from 'nestjs-mcp';

@Injectable()
export class CalculatorService {
  @Tool({
    name: 'add',
    description: 'Add two numbers together',
    parameters: {
      a: 'number',
      b: 'number',
    },
  })
  async add(params) {
    const { a, b } = params;
    const result = a + b;
    return result.toString();
  }
}

Create Prompts

import { Injectable } from '@nestjs/common';
import { Prompt } from 'nestjs-mcp';

@Injectable()
export class PromptService {
  @Prompt({
    name: 'greeting',
    description: 'Generate a personalized greeting',
    template: 'Hello, {{name}}! Welcome to {{application}}.',
    parameters: {
      name: 'string',
      application: 'string',
    },
  })
  async greetingParameters(params) {
    // You can modify or add to the parameters here
    return {
      currentTime: new Date().toLocaleTimeString(),
    };
  }
}

Advanced Configuration

Async Configuration

You can also configure the MCP module asynchronously:

import { Module } from '@nestjs/common';
import { MCPModule } from 'nestjs-mcp';
import { ConfigModule, ConfigService } from '@nestjs/config';

@Module({
  imports: [
    ConfigModule.forRoot(),
    MCPModule.registerAsync({
      imports: [ConfigModule],
      useFactory: (configService: ConfigService) => ({
        name: configService.get('MCP_SERVER_NAME'),
        version: configService.get('MCP_SERVER_VERSION'),
        sseEndpoint: configService.get('MCP_SSE_ENDPOINT', '/mcp/sse'),
        messagesEndpoint: configService.get('MCP_MESSAGES_ENDPOINT', '/mcp/messages'),
      }),
      inject: [ConfigService],
    }),
  ],
})
export class AppModule {}

API Reference

Decorators

@Resource(options)

Marks a method as an MCP resource handler.

  • name: The name of the resource
  • description: Description of the resource
  • parameters: Parameter schema definition

@Tool(options)

Marks a method as an MCP tool handler.

  • name: The name of the tool
  • description: Description of the tool
  • parameters: Parameter schema definition

@Prompt(options)

Marks a method as an MCP prompt handler.

  • name: The name of the prompt
  • description: Description of the prompt
  • template: The prompt template with placeholders
  • parameters: Parameter schema definition

Module Options

  • name: The name of the MCP server
  • version: The version of the MCP server
  • sseEndpoint: The endpoint for SSE (default: '/mcp/sse')
  • messagesEndpoint: The endpoint for messages (default: '/mcp/messages')
  • globalApiPrefix: Optional API prefix for all endpoints
  • capabilities: Optional capabilities object

Formatting and Linting

# Format the codebase
yarn format

# Check formatting
yarn format:check

# Lint the codebase
yarn lint

# Run all checks
yarn check

License

MIT

FAQs

Package last updated on 21 Mar 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts