MCP Starter Server 使用说明

项目简介

'mcp-starter' 是一个基于 Model Context Protocol (MCP) 的服务器启动模板,它提供了一个基础框架,用于构建可以扩展 AI 助手(如 Claude)功能的自定义工具。这个模板旨在简化 MCP 服务器的开发流程,让开发者能够快速上手并专注于工具功能的实现。

主要功能点

  • 基础 MCP 服务器框架: 实现了 MCP 协议的核心功能,可以处理来自 MCP 客户端的请求和响应。
  • 示例工具: 包含一个简单的 "hello world" 工具 ('hello_tool'),演示了如何定义和实现工具。
  • 易于扩展: 项目结构清晰,方便开发者添加新的资源、工具和 Prompt 模板。
  • 开发工具: 预配置了 TypeScript 和 esbuild,以及用于开发和调试的工具链。
  • Inspector 工具支持: 支持 MCP Inspector,方便开发者进行可视化测试和监控。
  • 发布流程: 提供了将服务器发布到 NPM 的简易步骤,方便分发和部署。

安装步骤

  1. 安装 Claude 桌面应用: 如果希望与 Claude 集成,请先从 claude.ai/download 下载并安装 Claude 桌面应用。
  2. 克隆仓库并安装依赖: 使用 git 克隆 'mcp-starter' 仓库到本地,并使用 npm 安装项目依赖。
    git clone https://github.com/MatthewDailey/mcp-starter.git
    cd mcp-starter
    npm install
  3. 构建项目: 运行构建命令,将 TypeScript 代码编译为 JavaScript。
    npm run build

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以 Claude 桌面应用为例,你需要编辑 Claude 的配置文件 'claude_desktop_config.json'。

配置文件路径:

  • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%\Claude\claude_desktop_config.json'
  • Linux: '~/.config/Claude/claude_desktop_config.json'

配置内容: 将以下 JSON 代码添加到 'claude_desktop_config.json' 文件中的 '"mcpServers"' 字段下。如果 'claude_desktop_config.json' 文件不存在或者 '"mcpServers"' 字段不存在,请按照 README.md 中的指示创建或修改。

"mcpServers": {
  "mcp-starter": {
    "command": "node",
    "args": ["<项目路径>/dist/index.cjs"]
  }
}

参数说明:

  • '"mcp-starter"': 服务器名称,可以自定义,用于在 Claude 中标识该服务器。
  • '"command"': 启动服务器的命令,这里使用 'node' 表示使用 Node.js 运行时环境。
  • '"args"': 启动服务器命令的参数,'"<项目路径>/dist/index.cjs"' 需要替换为 你本地 'mcp-starter' 项目的绝对路径,指向编译后的服务器入口文件 'dist/index.cjs'。例如,如果你的项目路径是 '/Users/yourname/mcp-starter',则应配置为 '"/Users/yourname/mcp-starter/dist/index.cjs"'。

配置示例 (macOS): 假设你的 'mcp-starter' 项目位于 '/Users/matt/code/mcp-starter',则配置应如下所示:

"mcpServers": {
  "mcp-starter": {
    "command": "node",
    "args": ["/Users/matt/code/mcp-starter/dist/index.cjs"]
  }
}

基本使用方法

  1. 重启 Claude 桌面应用: 配置完成后,需要重启 Claude 桌面应用,以加载新的 MCP 服务器配置。
  2. 查看工具: 如果配置正确,在 Claude 的界面中应该能看到一个锤子图标,图标上的数字表示可用的工具数量。点击锤子图标可以查看已注册的工具列表,其中应该包含 "hello_tool"。
  3. 开发模式: 使用 'npm run dev' 命令可以启动开发模式,它会自动监听文件更改并重新构建项目,方便开发和调试。
  4. Inspector 工具: 使用 'npm run inspect' 命令可以启动 MCP Inspector 工具,用于更详细地测试和监控 MCP 服务器的交互过程。

创建新工具

你可以参考 'index.ts' 文件中的 'hello_tool' 示例,按照以下步骤创建新的工具:

  1. 在 'index.ts' 中定义新的工具 schema (包括 'name', 'description', 'inputSchema')。
  2. 在 'ListToolsRequestSchema' 的请求处理函数中,将新工具添加到 'tools' 数组中。
  3. 在 'CallToolRequestSchema' 的请求处理函数中,添加处理新工具的逻辑代码。

发布服务器

如果希望将你的 MCP 服务器发布给其他人使用,可以按照 README.md 中的 "Publishing" 章节进行操作,将服务器发布到 NPM 上。

信息

分类

开发者工具