MCP-Nest 项目安装与配置指南

1. 项目基础介绍

MCP-Nest 是一个开源项目，旨在为 NestJS 应用程序提供一种简单的方式，通过 Model Context Protocol (MCP) 来暴露工具、资源和提示。该项目允许开发者利用 NestJS 的依赖注入功能，轻松地将 MCP 集成到他们的应用中。

主要编程语言：TypeScript

2. 关键技术和框架

• NestJS: 一个基于 Node.js 平台的开源框架，用于构建高效、可扩展的服务端应用程序。
• Model Context Protocol (MCP): 一个用于定义和执行机器学习工作流的协议。
• Zod: 一个用于 TypeScript 的强类型验证的库。
• GitHub Actions: 用于自动化项目的构建和测试。

3. 安装和配置

准备工作

在开始安装之前，请确保您的开发环境中已安装以下依赖项：

• Node.js（推荐使用 LTS 版本）
• npm 或 yarn 包管理器

安装步骤

1. 克隆项目仓库

   在您的本地开发环境中，使用以下命令克隆项目仓库：

   git clone https://github.com/rekog-labs/MCP-Nest.git
   

2. 安装依赖

   进入项目目录，安装项目所需的依赖：

   cd MCP-Nest
   npm install
   

   或者，如果您使用 yarn：

   yarn install
   

3. 配置项目

   根据您的需求配置项目。例如，您可能需要修改 app.module.ts 文件来添加自定义的工具或资源。

   // 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 {}
   

4. 运行项目

   使用以下命令启动项目：

   npm run start
   

   或者，如果您使用 yarn：

   yarn start
   

   项目启动后，您可以通过浏览器或其他 HTTP 客户端访问项目提供的 API 端点。

以上步骤为 MCP-Nest 项目的的基础安装和配置指南。在实际使用过程中，您可能还需要进行更多的配置和自定义以满足您的具体需求。