使用说明

项目简介

本仓库提供了一个 Model Context Protocol (MCP) 服务器的脚手架，旨在帮助开发者快速启动并开发自己的 MCP 服务器。它预置了基础的服务器结构和示例代码，开发者可以基于此模板添加自定义工具和业务逻辑，从而构建符合 MCP 协议规范的后端服务。

主要功能点

基础MCP服务器框架：实现了MCP协议的基本服务器结构，包括请求处理和响应机制。
工具注册示例：提供了注册和声明工具的示例代码，展示了如何向 MCP 客户端暴露服务器端的功能。
工具调用示例：演示了如何处理客户端的工具调用请求，并返回执行结果。
Stdio传输支持：使用 Stdio 作为默认的传输协议，方便本地开发和调试。
可扩展性：项目结构清晰，易于扩展和添加自定义功能，例如资源管理、Prompt模板支持等。

安装步骤

克隆仓库

git clone https://github.com/zcaceres/mcp-boilerplate
cd mcp-boilerplate

安装依赖
```
pnpm install
```
构建项目
```
pnpm run build
```

服务器配置 (MCP 客户端配置)

MCP 客户端需要配置以下 JSON，才能连接到此 MCP 服务器。请注意将 '{ABSOLUTE PATH TO FILE HERE}' 替换为 'dist/index.js' 文件在您电脑上的绝对路径。

{
  "mcpServers": {
    "my-boilerplate-server": { //  服务器名称，可以自定义
      "command": "node",      //  启动服务器的命令，这里使用 node
      "args": [              //  启动命令的参数
        "{ABSOLUTE PATH TO FILE HERE}/dist/index.js" //  指向编译后的服务器入口文件
      ]
    }
  }
}

重要: 请务必将 '{ABSOLUTE PATH TO FILE HERE}' 替换为 'dist/index.js' 文件的实际绝对路径。例如，如果你的项目路径是 '/Users/yourname/mcp-boilerplate'，那么 'dist/index.js' 的绝对路径可能是 '/Users/yourname/mcp-boilerplate/dist/index.js'。

基本使用方法

启动服务器
```
pnpm start
```
启动成功后，终端会输出 'Boilerplate MCP Server running on stdio'。
配置 MCP 客户端 将上面生成的服务器配置 JSON 添加到您的 MCP 客户端应用程序的配置文件中，并确保 '{ABSOLUTE PATH TO FILE HERE}' 已被替换为正确的路径。
客户端连接与交互 启动您的 MCP 客户端应用程序，客户端应该能够连接到此 MCP 服务器。您可以尝试从客户端调用预定义的工具 'your_tool_here' 进行测试。
自定义工具和逻辑 修改 'src/index.ts' 文件，在 'ListToolsRequestSchema' 的处理器中定义您的工具，并在 'CallToolRequestSchema' 的处理器中实现工具的具体逻辑。

关键词