jhenbertgit/nest-mcp-server

A progressive Node.js framework for building efficient and scalable server-side applications.

NestJS MCP Server

This project is a NestJS-based server implementation for the Model Context Protocol (MCP). It provides a robust and scalable backend for agents to discover and interact with various tools via a standardized API.

Description

This is a NestJS framework TypeScript starter repository, extended to function as an MCP server. It allows for the registration and execution of various tools, exposing them via HTTP endpoints. The server supports both standard request/response and Server-Sent Events (SSE) for streaming tool outputs.

Features

• Tool Management: Register and expose custom tools.
• Standardized API: Interact with tools via defined MCP endpoints.
• Streaming Support: Utilize Server-Sent Events (SSE) for real-time tool output.
• Extensible: Easily add new tools by implementing the McpTool interface.

Project setup

$ pnpm install

Compile and run the project

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

# start with stdio transport
$ pnpm run start:stdio

# start with http transport
$ pnpm run start:http

API Endpoints

The server exposes the following MCP-related endpoints:

• GET /mcp/server-info: Get basic server information and capabilities.
• GET /mcp/tools: List all available tool definitions.
• POST /mcp/tool/call: Call a specific tool with arguments. Supports SSE for streaming responses.

Implemented Tools

The following tools are currently implemented and available:

• file-search: Search for files within the project directory.
• filereader: Read the content of a specified file.
• ping: A simple tool for testing connectivity.

Adding New Tools

To add a new tool:

1. Create a new module and service under src/tools.
2. Implement the McpTool interface in your service.
3. Register your tool in src/mcp/mcp.module.ts by providing it to the MCP_TOOLS injection token.

Run tests

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ pnpm install -g mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.