使用说明

项目简介

本项目是一个简单的 MCP (Model Context Protocol) 服务器示例，它实现了一个工具 'generate_uuid'，可以生成 UUID (v4) 字符串。此服务器旨在演示如何使用 '@modelcontextprotocol/sdk' 构建基本的 MCP 服务器，并提供一个可供 MCP 客户端调用的功能。

主要功能点

UUID 生成工具: 提供 'generate_uuid' 工具，客户端调用后可以获取一个唯一的 UUID (v4) 字符串。
标准 MCP 服务器: 遵循 MCP 协议，可以与任何兼容 MCP 协议的客户端进行通信。
Stdio 传输: 使用标准输入输出 (stdio) 作为传输协议，简化部署和运行方式。

安装步骤

安装 Node.js 和 npm (或 yarn): 确保你的环境中已安装 Node.js 和包管理器 npm 或 yarn。
克隆仓库: 将仓库 'https://github.com/Suntory-Y-Water/uuid-mcp-server-example' 克隆到本地。
进入项目目录: 使用命令行工具进入克隆下来的项目目录 'uuid-mcp-server-example'。
安装依赖: 运行 'npm install' 或 'yarn install' 安装项目所需的依赖包。
构建项目: 运行 'npm run build' 或 'yarn build' (如果 'package.json' 中有 build 命令) 来编译 TypeScript 代码 (本项目 'package.json' 中没有build 命令，可跳过此步骤，直接运行 'index.ts')。

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到此 UUID MCP 服务器。请注意，以下配置信息不是在服务器端配置的，而是提供给 MCP 客户端 使用的。

{
  "serverName": "uuid-mcp-server",
  "command": "node",
  "args": ["src/index.ts"]
}

配置参数说明:

'serverName': 服务器名称，可以自定义，例如 "uuid-mcp-server"。
'command': 启动服务器的命令，这里使用 'node' 命令来运行 JavaScript 文件。
'args': 传递给 'command' 的参数，这里指定了服务器入口文件 'src/index.ts'。

注意: MCP 客户端需要能够执行 'node src/index.ts' 命令来启动服务器。请确保 Node.js 环境配置正确，并且 'src/index.ts' 文件路径相对于客户端的运行环境是正确的。

基本使用方法

启动服务器: 在项目根目录下，打开命令行工具，运行命令 'node src/index.ts' 启动 UUID MCP 服务器。你应该在控制台看到 'Weather MCP Server running on stdio' (实际应为 UUID MCP Server，此处为示例代码笔误，不影响功能)。服务器将通过 stdio 监听 MCP 客户端的请求。
配置 MCP 客户端: 在你的 MCP 客户端应用中，配置上述提供的 JSON 信息，指定连接到本地启动的 UUID MCP 服务器。
调用工具: 在 MCP 客户端中，可以使用 'generate_uuid' 作为工具名称来调用 UUID 生成功能。服务器将返回一个包含 UUID 字符串的响应。

例如，客户端可以发送一个请求调用 'generate_uuid' 工具，服务器会返回类似以下的 JSON 响应：

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "your-generated-uuid-string"
      }
    ]
  }
}

其中 '"text": "your-generated-uuid-string"' 部分就是服务器生成的 UUID (v4) 字符串。

关键词