Skip to content

A NestJS module to effortlessly create Model Context Protocol (MCP) servers for exposing AI tools, resources, and prompts.

License

Notifications You must be signed in to change notification settings

rekog-labs/MCP-Nest

Repository files navigation

NestJS MCP Server Module

CI Code Coverage NPM Version NPM Downloads NPM License

A NestJS module to effortlessly expose tools, resources, and prompts for AI, from your NestJS applications using the Model Context Protocol (MCP).

With @rekog/mcp-nest you define tools, resources, and prompts in a way that's familiar in NestJS and leverage the full power of dependency injection to utilize your existing codebase in building complex enterprise ready MCP servers.

Features

Are you interested to build ChatGPT widgets (with the OpenAI SDK)? Find out how to do that with @rekog/MCP-Nest in this repository MCP-Nest-Samples/pizzaz-openai-apps-sdk

Installation

npm install @rekog/mcp-nest @modelcontextprotocol/sdk zod@^3

Optional dependencies

If you use the built-in authorization server with the TypeORM store, install the following optional peer dependencies:

npm install @nestjs/typeorm typeorm

Quick Start

// app.module.ts
import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';
import { GreetingTool } from './greeting.tool';

@Module({
  imports: [
    McpModule.forRoot({
      name: 'my-mcp-server',
      version: '1.0.0',
    }),
  ],
  providers: [GreetingTool],
})
export class AppModule {}
// greeting.tool.ts
import { Injectable } from '@nestjs/common';
import { Tool, Context } from '@rekog/mcp-nest';
import { z } from 'zod';

@Injectable()
export class GreetingTool {
  @Tool({
    name: 'greeting-tool',
    description: 'Returns a greeting with progress updates',
    parameters: z.object({
      name: z.string().default('World'),
    }),
  })
  async sayHello({ name }, context: Context) {
    await context.reportProgress({ progress: 50, total: 100 });
    return `Hello, ${name}!`;
  }
}

Documentation

Playground

The playground directory contains working examples for all features. Refer to playground/README.md for details.

About

A NestJS module to effortlessly create Model Context Protocol (MCP) servers for exposing AI tools, resources, and prompts.

Topics

Resources

License

Stars

Watchers

Forks