项目简介

该项目是基于TypeScript语言实现的Model Context Protocol (MCP) 服务器模板,它使用Blaxel平台进行部署和管理。作为一个“Hello World”示例,它展示了如何构建一个简单的MCP服务器,其中包含一个可供AI Agent或大型语言模型通过标准化MCP接口调用的工具函数。

主要功能点

  • 实现MCP服务器功能: 基于MCP协议标准构建,能够处理来自MCP客户端的请求。
  • 提供'hello_world'工具: 内置一个简单的工具函数,接收一个名为'firstname'的字符串参数,并返回一个包含问候消息的文本内容。
  • 支持多种通信协议: 默认支持Stdio传输协议,同时也集成了对Blaxel平台特定传输协议的支持。
  • 集成Blaxel平台: 方便地将MCP服务器作为函数部署到Blaxel平台。
  • TypeScript开发: 使用TypeScript编写,提供了类型安全和更好的代码组织。

安装步骤

  1. 确保您的系统已安装 Node.js 18+PNPM (或者使用npm)。
  2. 克隆项目仓库到本地:
    git clone https://github.com/blaxel-templates/template-mcp-hello-world-ts.git
  3. 进入项目目录:
    cd template-mcp-hello-world-ts
  4. 安装项目依赖:
    pnpm install
    # 或者如果您使用npm:
    # npm install

服务器配置

MCP服务器启动后通常通过Stdio或特定协议与MCP客户端通信。对于MCP客户端来说,需要知道如何启动这个服务器进程。客户端通常需要配置以下信息:

  • 服务器名称 (Server Name): 'mcp-helloworld'
  • 启动命令 (Command): 用于启动服务器进程的命令行程序,例如 'npm'。
  • 启动参数 (Arguments): 传递给启动命令的参数数组,例如 '["run", "prod"]'(这会执行'package.json'中名为'prod'的脚本,该脚本通常用于启动编译后的生产版本服务器)。

这些配置信息是MCP客户端用来启动和连接服务器进程的关键,通常以JSON格式存储在客户端的配置文件中。

基本使用方法

  1. 开发模式启动 (带热重载):
    pnpm dev
    # 或者 npm dev
  2. 编译 TypeScript 代码:
    pnpm run build
    # 或者 npm run build
  3. 生产模式启动:
    pnpm run prod
    # 或者 npm run prod
  4. 使用MCP Inspector测试:
    pnpm run inspect
    # 或者 npm run inspect
    运行此命令会启动官方MCP inspector工具,连接到本地运行的服务器,允许您测试'hello_world'等工具功能。

信息

分类

开发者工具