使用说明

项目简介

Boot-MCP 是一个用于快速搭建 Model Context Protocol (MCP) 服务器的启动器模板。它提供了一套完整的框架，包括资源管理、工具注册、Prompt 模板定义以及多种传输协议支持，旨在帮助开发者快速构建能够与 LLM 应用进行标准化交互的后端服务。你可以使用这个模板快速创建一个功能完备的 MCP 服务器，并根据需要进行扩展和定制。

主要功能点

资源 (Resources): 支持文本和二进制资源的管理和访问，允许客户端获取信息作为 LLM 的上下文。内置常见资源类型示例。
工具 (Tools): 支持注册和执行外部功能，例如系统命令执行、文件读写、数据处理等，使 LLM 能够调用外部能力。内置多种实用工具示例。
Prompt 模板 (Prompts): 支持定义可复用的 Prompt 模板，简化和标准化 LLM 交互模式。内置常用 Prompt 模板示例。
传输协议 (Transports): 支持 Stdio 和 HTTP/SSE 两种传输协议，适应不同的应用场景，例如命令行工具和 Web 应用。
根目录 (Roots): 支持定义服务器操作的根目录范围，增强安全性。
可扩展性: 项目采用模块化设计，易于扩展和添加自定义资源、工具和 Prompt。
开发友好: 使用 TypeScript 开发，提供类型定义和良好的代码组织，提升开发效率。

安装步骤

安装 Node.js 和包管理器: 确保你的电脑上已安装 Node.js (>=16.x) 和 npm, pnpm 或 yarn 其中一种包管理器。

克隆仓库: 将仓库 'https://github.com/kirklin/boot-mcp' 克隆到本地。

git clone https://github.com/kirklin/boot-mcp
cd boot-mcp

安装依赖: 在项目根目录下运行以下命令安装项目依赖。

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

构建项目: 运行构建命令编译 TypeScript 代码。
```
pnpm build
```
构建完成后，编译后的 JavaScript 文件将位于 'dist' 目录下。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和参数才能连接。以下是针对不同服务器类型的配置示例 (JSON 格式)：

1. Stdio 服务器配置 (basic, tools, resources 类型):

{
  "serverName": "Example MCP Server",
  "command": "node",
  "args": [
    "dist/cli.js",
    "basic"  // 或 "tools", "resources"  选择启动的服务器类型
  ],
  "説明": "启动一个基本的 StdIO MCP 服务器，支持资源、工具和 Prompt 功能 (basic 类型)。或者选择 tools 或 resources 类型启动仅包含特定功能的服务器。"
}

参数说明:

'serverName': 服务器名称，可以自定义。
'command': 启动服务器的命令，这里使用 'node' 运行 JavaScript 文件。
'args': 命令参数，'dist/cli.js' 是编译后的 CLI 入口文件，'basic' (或 'tools', 'resources') 指定启动的服务器类型。

2. HTTP 服务器配置 (http 类型):

{
  "serverName": "Example HTTP MCP Server",
  "command": "node",
  "args": [
    "dist/cli.js",
    "http"
  ],
  "説明": "启动一个 HTTP MCP 服务器，通过 HTTP/SSE 协议提供服务。",
  "transport": {
    "type": "sse",
    "baseUrl": "http://localhost:3000"  // HTTP 服务器的基地址
  }
}