项目简介

MCP服务器快速启动模板(MCP Boilerplate)是一个强大的、生产就绪的Model Context Protocol (MCP) 服务器实现。它提供了一个坚实的基础,帮助开发者快速构建将大型语言模型(LLM)与外部数据源和功能集成的后端服务。

主要功能点

  • 生产级稳定性: 专为企业级应用设计,注重稳定性和性能。
  • 健壮的SSE传输: 利用Server-Sent Events (SSE) 高效地向客户端(如LLM)流式传输数据和通知。
  • 全面的错误处理: 内置详细的错误报告和重试机制,确保服务器平稳运行。
  • 内置工具支持: 方便注册和调用工具,扩展LLM的能力(预置一个简单的计算器工具示例)。
  • 无缝集成: 轻松连接AI模型到各种数据源和外部服务。

安装步骤

要运行此MCP服务器,您需要 Node.js (v14+) 和 npm。

  1. 克隆仓库:
    git clone https://github.com/milxxyzxc/mcp-boilerplate.git
  2. 进入项目目录:
    cd mcp-boilerplate
  3. 安装依赖:
    npm install
  4. 启动服务器:
    npm start

服务器默认将在 'http://localhost:4005' 运行。启动后,控制台会打印出服务器监听的地址和端口,以及SSE连接的URL(包含API密钥)。

服务器配置

MCP客户端需要知道如何启动并连接到此服务器。典型的MCP客户端配置文件(JSON格式)需要包含以下信息来启动这个Node.js应用:

{
  // 服务器的名称,用于标识
  "name": "mcp-boilerplate",
  // 启动服务器进程的命令
  "command": "npm",
  // 传递给命令的参数,用于启动服务器
  "args": ["start"],
  // (可选) 如果客户端通过网络连接(如SSE),需要提供连接详情
  "connection": {
    "transport": "sse", // 指定传输协议为SSE
    // SSE连接的完整URL,请参考服务器启动时控制台输出的URL
    // 或根据config.ts中的host、port、apiKey自行构建
    "url": "http://localhost:4005/sse?API_KEY=dev_key" 
  }
}

请注意:上述JSON结构是一个示例,用于说明客户端如何通过命令行启动并连接到此服务器。实际的客户端配置取决于您使用的MCP客户端及其支持的特性。连接URL中的'API_KEY'需要与服务器配置('config.ts'或环境变量)中的值一致。

基本使用方法

服务器启动后,它会监听配置的端口(默认为4005)。MCP客户端可以通过配置相应的传输方式(如SSE),使用启动时提供的URL连接到服务器。连接建立后,客户端可以:

  • 请求服务器列出可用的工具(通过'tools/list'请求),获取工具的名称、描述和参数schema。
  • 调用服务器上注册的工具(通过'tools/call'请求),并传递工具所需的参数,服务器会执行相应的工具逻辑并返回结果。
  • 接收服务器通过SSE推送的实时通知(如日志信息、工具执行状态、资源更新等)。

开发者可以通过修改 'src/tools.ts' 文件来添加新的工具,并通过修改 'src/config.ts' 文件来调整服务器的各项设置(如端口、日志级别、API密钥、重试次数等)。

信息

分类

AI与计算