MCP Server Starter 使用说明

项目简介

本项目 'MCP Server Starter' 是一个基于 Model Context Protocol (MCP) 的服务器启动器模板,旨在帮助开发者快速搭建 MCP 服务器。MCP 服务器作为 LLM 应用的后端,主要负责提供上下文信息和工具能力,使 LLM 能够安全、可扩展地访问外部资源和服务。

主要功能点

  • MCP 协议实现: 基于 '@modelcontextprotocol/sdk' 实现了 MCP 协议的核心功能,能够处理来自 MCP 客户端的请求。
  • 工具 (Tools) 管理: 支持注册和管理工具,允许 LLM 调用外部功能。模板中包含一个示例工具,并提供了创建新工具的脚本。
  • 可扩展性: 项目结构清晰,易于扩展和维护。可以方便地添加新的工具和功能。
  • 开发工具: 使用 Bun 进行快速开发和测试,Biome 进行代码格式化和检查,提升开发效率。
  • 版本管理: 集成 'standard-version' 实现自动化版本管理。
  • Claude Desktop 集成: 提供详细的 Claude Desktop 集成指南,方便用户将 MCP 服务器与 Claude Desktop 客户端连接。
  • Stdio 传输协议: 默认使用 Stdio 作为传输协议,简单易用。

安装步骤

  1. 克隆仓库
    git clone https://github.com/StevenStavrakis/mcp-starter-template
    cd mcp-starter-template
  2. 安装依赖 确保已安装 Bun,然后运行:
    bun install

服务器配置

要将此 MCP 服务器添加到 Claude Desktop,您需要配置 Claude Desktop 的 MCP 服务器设置。配置信息为 JSON 格式,示例如下:

{
  "mcpServers": {
    "your-server-name": {  // 您自定义的服务器名称,用于在 Claude Desktop 中标识您的服务器
      "command": "node",  // 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件
      "args": ["/path/to/your/project/dist/main.js"] // 启动命令的参数,指向编译后的服务器入口文件路径。请替换为您的项目 'dist/main.js' 文件的绝对路径
    }
  }
}

配置说明:

  • '"your-server-name"': 为您的 MCP 服务器指定一个名称,例如 '"my-tool-server"'。这个名称将显示在 Claude Desktop 的 MCP 服务器列表中。
  • '"command": "node"': 指定用于启动服务器的命令。由于本项目编译为 JavaScript 代码,通常使用 'node' 命令来运行。
  • '"args": ["/path/to/your/project/dist/main.js"]': 指定传递给启动命令的参数,这里是一个字符串数组。
    • '"args"' 数组中的第一个元素是服务器入口文件 'main.js' 的路径。请务必将 '"/path/to/your/project/dist/main.js"' 替换为您的项目编译后 'dist/main.js' 文件的实际绝对路径。 例如,如果您的项目位于 '/Users/yourname/mcp-starter',则路径可能为 '"/Users/yourname/mcp-starter/dist/main.js"'。

获取 'dist/main.js' 路径的步骤:

  1. 构建项目: 在项目根目录下运行 'bun run build' 命令,这将编译 TypeScript 代码并将输出文件放置在 'dist' 目录中。
  2. 查找路径: 构建成功后,在项目目录中找到 'dist/main.js' 文件。复制该文件的绝对路径。您可以使用终端命令 'pwd' 获取当前目录的绝对路径,然后手动拼接或使用文件管理器复制路径。

配置 Claude Desktop:

  1. 打开 Claude Desktop 客户端。
  2. 进入设置或偏好设置 (Preferences)。
  3. 找到 MCP 服务器 (MCP Servers) 或类似的配置项。
  4. 点击 "添加服务器" (Add Server) 或类似按钮。
  5. 将上述 JSON 配置信息填入 Claude Desktop 的配置界面,并确保将 '"/path/to/your/project/dist/main.js"' 替换为正确的路径。

基本使用方法

  1. 启动服务器: Claude Desktop 客户端配置完成后,当您在 Claude Desktop 中启用您配置的 MCP 服务器时,客户端会根据您提供的配置自动启动服务器。
  2. 使用工具: 一旦服务器成功启动并连接到 Claude Desktop,您就可以在 Claude Desktop 中使用服务器提供的工具了。具体工具的使用方式取决于您在服务器中定义的工具的功能和描述。LLM 会根据工具的描述和输入参数,智能地建议或调用相应的工具来辅助完成任务。
  3. 开发新工具: 如果您需要添加新的工具,可以参考项目中的示例工具,并使用 'bun run scripts/create-tool.ts <tool-name>' 脚本快速创建工具模板。

通过以上步骤,您就可以成功使用 'MCP Server Starter' 模板构建并运行您的 MCP 服务器,并将其集成到 Claude Desktop 中,为 LLM 应用提供强大的上下文和工具能力。

信息

分类

开发者工具