项目简介: 这是一个使用 Node.js 和 TypeScript 构建的 Model Context Protocol (MCP) 服务器模板。它提供了创建 MCP 服务器所需的基础结构,支持通过标准输入输出 (Stdio) 或 Server-Sent Events (SSE) 协议与客户端通信,并包含了示例资源、工具和Prompt模板,帮助开发者快速搭建 MCP 后端服务。

主要功能点:

  • 使用 TypeScript 开发,提供良好的类型安全和开发体验。
  • 支持通过标准输入输出 (Stdio) 或 Server-Sent Events (SSE) 两种传输协议进行通信。
  • 包含如何定义和添加 MCP 资源(如日志、文件内容)、工具(如计算、外部API调用)和 Prompt 模板的示例。
  • 基于 FastMCP 框架构建,简化 MCP 服务器的开发过程。

安装步骤:

  1. 获取仓库代码。你可以直接克隆这个仓库,或者在 GitHub 上使用“Use this template”功能创建一个新仓库。
  2. 进入项目所在的目录。
  3. 运行以下命令安装所需的依赖:
    npm install
    # 或者使用 yarn
    # yarn install

服务器配置(供 MCP 客户端使用): MCP 服务器是为 MCP 客户端提供服务的后端。MCP 客户端(例如支持 MCP 的 LLM 客户端或IDE插件)需要配置如何连接到你的 MCP 服务器。以下是常见的两种配置方式,你需要根据你的服务器实际运行方式(Stdio 或 HTTP/SSE)选择并提供给客户端:

  • Stdio 模式: 适用于客户端和服务器在同一台机器上,并且客户端直接启动服务器进程进行通信的场景。
    {
        "mcpServers": {
            "example-server": { // 给你的服务器起一个方便识别的名称
                "command": "node", // 客户端用于启动服务器进程的命令
                "args": [ "dist/server.js" ] // 传递给启动命令的参数,通常指向你的服务器主程序文件
            }
        }
    }
  • SSE 模式: 适用于服务器作为一个独立的 HTTP 服务运行,客户端通过网络 URL 连接的场景。
    {
        "mcpServers": {
            "example-server": { // 给你的服务器起一个方便识别的名称
                "url": "https://example-server.com/sse" // MCP 服务器的 SSE 服务端点完整 URL
            }
        }
    }
    (注意:你需要将 '"https://example-server.com/sse"' 替换为你实际部署的服务器地址和路径。)

基本使用方法: 安装依赖后,你可以运行以下命令来启动编译后的 MCP 服务器:

npm start
# 或者使用 yarn
# yarn start

服务器启动后,配置了相应连接信息的 MCP 客户端即可与之建立连接。客户端可以通过 MCP 协议请求访问服务器上托管的资源、调用注册的工具或使用Prompt模板,从而获取上下文信息或执行特定任务。这个模板中已经包含了一些示例资源、工具和Prompt,你可以根据需要修改或添加自己的实现。

信息

分类

AI与计算