Untappd MCP 服务器使用说明
项目简介
本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在通过 Untappd API 为大型语言模型 (LLM) 提供啤酒相关的信息查询能力。它定义了一系列工具,允许 LLM 客户端调用以搜索啤酒、获取啤酒详情等。
请注意: Untappd API 目前已不再接受新的 API 密钥注册。您可能需要已有的 API 密钥才能正常使用此服务器。
主要功能点
- 啤酒搜索 (search_beer): 允许 LLM 客户端根据啤酒名称在 Untappd 上搜索啤酒。
- 啤酒信息查询 (get_beer_info): 允许 LLM 客户端通过啤酒 ID 获取啤酒的详细信息。
- 用户签到查询 (get_user_checkins): (目前不可用) 计划支持查询用户的啤酒签到记录。
- MCP 协议支持: 遵循 MCP 协议标准,可以与任何兼容 MCP 协议的 LLM 客户端进行通信。
安装步骤
-
克隆仓库:
git clone https://github.com/jtucker/mcp-untappd-server cd mcp-untappd-server -
安装依赖: 确保您已安装 Node.js 和 npm。在项目根目录下运行:
npm install -
构建服务器:
npm run build构建成功后,会在项目根目录下生成 'build' 目录,服务器程序 'index.js' 位于 'build' 目录中。
-
设置环境变量: 此服务器需要 Untappd API 的 'CLIENT_ID' 和 'CLIENT_SECRET' 环境变量。您需要拥有 Untappd API 开发者账号并获取 API 密钥。 在您的运行环境中设置这两个环境变量,例如在 Linux/macOS 中:
export CLIENT_ID=YOUR_UNTAPPD_CLIENT_ID export CLIENT_SECRET=YOUR_UNTAPPD_CLIENT_SECRET或者在 Windows 命令行中:
set CLIENT_ID=YOUR_UNTAPPD_CLIENT_ID set CLIENT_SECRET=YOUR_UNTAPPD_CLIENT_SECRET请将 'YOUR_UNTAPPD_CLIENT_ID' 和 'YOUR_UNTAPPD_CLIENT_SECRET' 替换为您实际的 API 密钥。
服务器配置 (MCP 客户端)
要将此 MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),您需要提供服务器的启动命令。以下是一个 JSON 格式的配置示例,您需要将其添加到您的 MCP 客户端配置文件中。以 Claude Desktop 为例,配置文件路径通常为:
- macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
配置内容示例:
{ "mcpServers": { "untappd-server": { "command": "/path/to/mcp-untappd-server/build/index.js" } } }
配置参数说明:
- '"untappd-server"': 服务器名称,您可以自定义,用于在 MCP 客户端中标识此服务器。
- '"command"': 重要,MCP 服务器的启动命令。请将 '/path/to/mcp-untappd-server/build/index.js' 替换为 您本地 'mcp-untappd-server' 项目 'build/index.js' 文件的绝对路径。 例如,如果您的项目位于 '~/Documents/mcp-untappd-server',则 'command' 应设置为 '"/Users/your_username/Documents/mcp-untappd-server/build/index.js"' (macOS) 或 '"C:\Users\YourUsername\Documents\mcp-untappd-server\build\index.js"' (Windows)。
请务必使用绝对路径,并确保路径中的斜杠方向与您的操作系统一致。
基本使用方法
-
启动 MCP 服务器: 在终端中,导航到 'mcp-untappd-server' 项目根目录,并运行以下命令启动服务器:
node build/index.js服务器成功启动后,会在终端输出 'Untappd MCP server running on stdio'。
-
配置 MCP 客户端: 根据您的 MCP 客户端 (如 Claude Desktop) 的文档,将上面提供的服务器配置信息添加到客户端的配置文件中。
-
在 LLM 中使用工具: 当您在 MCP 客户端中使用 LLM 时,您应该可以通过指令或特定语法来调用此 MCP 服务器提供的工具。具体的调用方式取决于您的 LLM 客户端实现。例如,您可能会使用类似 '@untappd-server:search_beer(query="啤酒名称")' 的语法来调用 'search_beer' 工具。请参考您的 LLM 客户端的文档,了解如何使用 MCP 服务器和工具。
注意事项
- 确保您已正确设置 'CLIENT_ID' 和 'CLIENT_SECRET' 环境变量。
- 'get_user_checkins' 工具目前可能无法正常工作,请关注仓库更新。
- 请仔细检查 MCP 客户端的配置文件路径和服务器 'command' 配置是否正确。
- 如果遇到连接问题,可以尝试使用 'npm run inspector' 命令启动 MCP Inspector 进行调试。
信息
分类
网页与API