Nestjs MCP

🚀 NestJS MCP Module English Documentation

The NestJS MCP module is the first official NestJS module built for the Model Context Protocol (MCP). It allows you to quickly create, manage, and use resources, tools, and prompts in a way that complies with MCP standards. This module is designed to seamlessly integrate with other NestJS features, enabling developers to focus on building efficient and scalable applications.

✨ Features

• Plug-and-Play: Quickly register services as MCP resources, tools, or prompts with simple decorators.
• Support for Multiple Content Types: Automatically handle common content types such as text, JSON, and files out of the box.
• Scalable: The module has a clear structure and is easy to extend and customize according to your needs.

📦 Installation

Install with npm

npm install @nestjs/mcp --save

Install with Yarn

yarn add @nestjs/mcp

Install with pnpm

pnpm add @nestjs/mcp

🚀 Quick Start

Here is a simple NestJS application example showing how to quickly start using the MCP module:

Create the Project Structure

your_project/
├── src/
│   ├── decorators/
│   │   └── mcp.decorators.ts
│   ├── modules/
│   │   └── mcp.module.ts
│   └── app.controller.ts

Install Dependencies

Make sure you have installed the following dependencies:

npm install @nestjs/mcp @nestjs/common @nestjs/core express

📚 Documentation

Project Structure and Configuration Options

In mcp.module.ts, you can optionally use and configure the MCP module:

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

@Module({
  imports: [
    McpModule.forRoot({
      // Optional root module configuration options
    }),
  ],
})
export class McpModule {}

You can also set MCP module options in environment variables:

# Example .env file
NCP_API_KEY=your_api_key_here
NCP_BASE_URL=https://api.example.com

Resource Template Example

Here is an example of a resource template:

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

@Module({
  imports: [McpModule],
})
export class MyModule {}

// Example resource definition
interface MyResource {
  id: string;
  name: string;
}

@McpResource('my-resource', '/api/my-resources')
export class MyResourceController {
  @Post()
  async create(@Body() resource: MyResource) {
    // Implement the creation logic
  }

  @Get(':id')
  async get(@Param('id') id: string) {
    // Implement the retrieval logic
  }
}

Tool Methods

Use the @McpTool Decorator

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

@Module({
  imports: [McpModule],
})
export class MyModule {}

// Example tool definition
interface MyTool {
  id: string;
  name: string;
}

@McpTool('my-tool', '/api/my-tools')
export class MyToolController {
  @Post()
  async execute(@Body() tool: MyTool) {
    // Implement the execution logic
  }
}

Call a Tool

import { McpTools } from '@nestjs/mcp';

// Example method to call a tool
async function callMyTool() {
  const result = await McpTools.myTool.execute({
    id: '1',
    name: 'Test Tool',
  });

  console.log('Tool execution result:', result);
}

Prompt System

Use the @McpPrompt Decorator

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

@Module({
  imports: [McpModule],
})
export class MyModule {}

// Example prompt definition
interface MyPrompt {
  id: string;
  input: string;
}

@McpPrompt('my-prompt', '/api/my-prompts')
export class MyPromptController {
  @Post()
  async handle(@Body() prompt: MyPrompt) {
    // Implement the handling logic
  }
}

Configure Module Options

In mcp.module.ts, you can optionally use and configure the MCP module:

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

@Module({
  imports: [
    McpModule.forRoot({
      apiKey: 'your_api_key_here',
      baseUrl: 'https://api.example.com',
    }),
  ],
})
export class McpModule {}

Environment Variable Configuration

You can load environment variables in mcp.module.ts:

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

@Module({
  imports: [
    McpModule.forRoot({
      loadEnv: true,
    }),
  ],
})
export class McpModule {}

🔧 Development and Contribution Guide

Clone the Repository

git clone git@github.com:nestjsorg/mcp.git
cd mcp
npm install

Run Tests

npm run test

Submit Code

Please follow standard commit conventions to ensure code style and documentation consistency.

📄 License

The MCP module is licensed under the MIT license. See the LICENSE file for details.

🔗 Links

• Official Documentation: https://nestjs.com/mcp/docs
• GitHub Repository: [https://github.com/nest