项目简介

该模板提供了一个现代化的、开箱即用的MCP服务器实现,利用Model Context Protocol TypeScript SDK,支持TypeScript、Vite构建、Express HTTP服务、Docker容器化以及代码质量工具。它包含一个示例工具,帮助开发者快速理解如何集成自定义功能,是构建和扩展LLM应用后端的理想起点。

主要功能点

  • 上下文服务: 提供标准化的方式向大型语言模型(LLM)客户端提供上下文信息。
  • 工具调用: 注册和执行自定义工具,使LLM能够调用外部功能和数据。
  • 会话管理: 支持多会话处理,确保每次LLM交互的独立性和状态管理。
  • HTTP传输: 通过Express框架提供稳定、高性能的HTTP/JSON-RPC通信。
  • 易于扩展: 提供清晰的项目结构和API,方便开发者快速添加新的工具、资源和业务逻辑。
  • Docker支持: 提供Docker配置,便于应用的容器化部署和运行。

安装步骤

  1. 创建新项目: 在您的命令行中运行以下命令,从模板创建新项目:
    npx degit nickytonline/mcp-typescript-template my-mcp-server
    cd my-mcp-server
  2. 安装依赖: 进入项目目录后,安装所有必需的Node.js依赖:
    npm install
  3. 构建项目: 编译TypeScript代码并生成可执行文件:
    npm run build
  4. 启动服务器: 启动MCP服务器:
    npm start
    服务器将在 'http://localhost:3000' 监听MCP客户端连接。

服务器配置

MCP客户端需要以下配置信息来连接到此MCP服务器。请根据您的实际部署环境调整'url'地址。

{
  "name": "mcp-typescript-template",
  "command": "npm",
  "args": ["start"],
  "environment": {
    "PORT": 3000,
    "SERVER_NAME": "mcp-typescript-template",
    "SERVER_VERSION": "1.0.0"
  },
  "transport": {
    "type": "http",
    "url": "http://localhost:3000/mcp"
  }
}

配置参数注释:

  • 'name': 服务器的唯一名称,默认为 'mcp-typescript-template'。
  • 'command': 启动MCP服务器的命令。这里是 'npm'。
  • 'args': 传递给启动命令的参数。这里是 'start',用于执行 'package.json' 中定义的启动脚本。
  • 'environment': 运行时环境变量配置。
    • 'PORT': 服务器监听的端口号,默认为 '3000'。
    • 'SERVER_NAME': 服务器对外宣称的名称。
    • 'SERVER_VERSION': 服务器的版本号。
  • 'transport': 定义MCP客户端与服务器通信的方式。
    • 'type': 传输协议类型,这里是 'http'。
    • 'url': MCP服务器的HTTP端点地址,客户端将通过此地址发送请求。

基本使用方法

服务器启动后,您可以使用 MCP Inspector 工具进行测试和调试。

  1. 安装 MCP Inspector: 在命令行中运行:
    npx @modelcontextprotocol/inspector
  2. 连接服务器: 启动MCP Inspector后,它会打开一个Web界面。您可以在其中配置连接URL为 'http://localhost:3000/mcp',然后连接到您的MCP服务器。
  3. 测试工具: 连接成功后,您可以看到服务器注册的 'echo' 工具。您可以向其发送消息进行测试,例如,在Inspector的工具调用界面输入以下参数:
    {
      "message": "Hello from MCP Inspector!"
    }
    服务器将把该消息原样返回。您可以按照 'Customizing Your MCP Server' 部分的指南,修改 'src/index.ts' 文件来添加更多自定义工具和业务逻辑。

信息

分类

开发者工具