使用说明
项目简介
本项目 'mcp-quickstart' 是一个基于 Model Context Protocol (MCP) 的简易服务器实现,旨在帮助开发者快速上手并理解 MCP 服务器的基本运作原理。它提供了一个简单的天气查询工具作为示例,展示了 MCP 服务器如何向 LLM 客户端提供工具能力。
主要功能点
- 工具注册与发现: 服务器声明并提供了一个名为 'check-weather' 的工具,用于查询天气信息。LLM 客户端可以通过 MCP 协议发现并了解该工具的功能描述和参数定义。
- 工具调用执行: 服务器能够接收并处理来自 LLM 客户端的工具调用请求,执行 'check-weather' 工具,并返回模拟的天气查询结果。
- 标准 MCP 协议通信: 服务器使用 '@modelcontextprotocol/sdk' 库构建,遵循 MCP 协议规范,能够与任何实现了 MCP 客户端的应用程序进行通信,例如 Claude 桌面应用。
- Stdio 传输协议: 服务器使用 Stdio (标准输入输出) 作为默认的传输协议,简化了部署和运行方式。
安装步骤
- 安装 Bun: 确保你的系统中已安装 Bun (一个快速的 JavaScript 运行时和包管理器)。
- 克隆仓库并安装依赖: 在终端中执行以下命令:
git clone https://github.com/dexaai/mcp-quickstart.git mcp-quickstart && cd mcp-quickstart && bun install - 获取服务器脚本绝对路径: 复制 'server.ts' 文件的绝对路径。在终端中执行以下命令,并将输出复制到剪贴板:
realpath server.ts | pbcopy
服务器配置
要将此 MCP 服务器与 MCP 客户端(例如 Claude 桌面应用)连接,你需要配置客户端以指向该服务器。以下是 Claude 桌面应用的配置示例,你需要将 '<path/to/repo>/server.ts' 替换为你步骤 3 中复制的 'server.ts' 文件的绝对路径。
{ "mcpServers": { "weather-quickstart": { // 服务器名称,可以自定义 "command": "bun", // 启动服务器的命令,这里使用 bun 运行时 "args": ["<path/to/repo>/server.ts"] // 启动命令的参数,指向 server.ts 脚本的绝对路径 } } }
配置步骤:
- 打开 Claude 桌面应用的配置文件。该文件通常位于:'~/Library/Application\ Support/Claude/claude_desktop_config.json' (macOS)。
- 将上面的 JSON 配置代码块添加到 'claude_desktop_config.json' 文件中的 '"mcpServers"' 字段下。
- 重要: 将 '"args"' 数组中的 '<path/to/repo>/server.ts' 替换为你实际的 'server.ts' 文件绝对路径。
- 保存 'claude_desktop_config.json' 文件。
- 重启 Claude 桌面应用。
基本使用方法
配置完成后,重启 Claude 桌面应用,你就可以通过 Claude 与你的 MCP 服务器进行交互了。你可以尝试向 Claude 提问关于天气的问题,例如:
- "What's the weather like in London?"
- "今天北京天气怎么样?"
Claude 应该能够检测到你的 MCP 服务器提供的 'check-weather' 工具,并尝试调用它来获取天气信息。服务器会返回模拟的天气信息给 Claude。
请注意: 此示例中的天气查询功能是模拟的,'getWeather' 函数返回的是固定的信息,并非真实的天气数据。此项目主要用于演示 MCP 服务器的框架和基本流程。
信息
分类
网页与API