使用说明
项目简介
本项目 'boilerplate-mcp-server' 是一个基于 Model Context Protocol (MCP) 协议的服务器端脚手架,使用 TypeScript 开发。它旨在帮助开发者快速搭建 MCP 服务器,以便为 Claude Desktop、Cursor AI 等 LLM 客户端提供工具和资源扩展能力。该项目结构清晰,包含自动化工作流和易于部署的特性,可以作为构建 MCP 兼容服务器的起点。
主要功能点
- STDIO MCP 服务器: 通过标准输入输出 (STDIO) 与 LLM 客户端(如 Claude Desktop)通信,提供工具和资源。
- IP 地址信息查询工具: 提供查询 IP 地址详细信息的功能,包括查询当前设备 IP 或指定 IP 地址的地理位置、运营商等信息。
- IP 地址资源: 将当前设备 IP 地址信息作为资源暴露给 LLM 客户端,允许客户端直接访问。
- CLI 命令行工具: 除了作为 MCP 服务器运行,也提供了友好的命令行界面,方便开发者直接测试和使用 IP 地址查询功能。
- 自动化发布: 通过 GitHub Actions 实现持续集成、测试和发布到 GitHub Packages,简化开发流程。
安装步骤
由于这是一个脚手架项目,更推荐直接使用其预构建版本,无需手动安装。在 Claude Desktop 或 Cursor AI 中配置 MCP 服务器时,可以直接使用 'npx' 命令运行该项目。
如果需要本地开发或修改,可以按照以下步骤操作:
- 安装 Node.js 和 npm: 确保你的电脑上安装了 Node.js 和 npm (Node 包管理器)。
- 拉取代码: 'git clone https://github.com/aashari/boilerplate-mcp-server.git'
- 进入项目目录: 'cd boilerplate-mcp-server'
- 安装依赖: 'npm install'
- 构建项目: 'npm run build' (可选,如果需要本地构建)
服务器配置
MCP 服务器主要供 MCP 客户端(如 Claude Desktop, Cursor AI)使用。你需要在 MCP 客户端中配置服务器的启动命令和参数。
以下是 Claude Desktop 和 Cursor AI 的配置示例,重点是配置 'command' 和 'args' 字段。
Claude Desktop 配置 (编辑 'claude_desktop_config.json' 文件):
{ "mcpServers": { "aashari/boilerplate-mcp-server": { "command": "npx", "args": ["-y", "aashari/boilerplate-mcp-server"] } } }
参数说明:
- '"command": "npx"': 指定使用 'npx' 命令来运行。'npx' 允许你直接运行 npm 包,无需全局安装。
- '"args": ["-y", "aashari/boilerplate-mcp-server"]': 传递给 'npx' 的参数。
- '"-y"': 'npx' 参数,表示自动确认执行 npm 包。
- '"aashari/boilerplate-mcp-server"': 指定要运行的 npm 包名称,即该 MCP 服务器的包名。
Cursor AI 配置 (在 Cursor 设置中添加 MCP 服务器):
配置 1: 使用全局配置 (推荐)
- Name: 'aashari/boilerplate-mcp-server' (服务器名称,自定义)
- Type: 'command' (选择命令类型)
- Command: 'npx -y aashari/boilerplate-mcp-server'
配置 2: 直接配置环境变量
- Name: 'aashari/boilerplate-mcp-server' (服务器名称,自定义)
- Type: 'command' (选择命令类型)
- Command: 'DEBUG=true IPAPI_API_TOKEN=your_token npx -y aashari/boilerplate-mcp-server'
参数说明 (通用):
- 'DEBUG=true': (可选) 启用 Debug 日志输出,方便调试。
- 'IPAPI_API_TOKEN=your_token': (可选) 用于 IP API 服务的 API Token。如果需要更精确的 IP 地址信息查询,你可能需要在 ip-api.com 申请 API Token 并配置。如果不需要可以省略,但可能会受到 IP API 服务的免费使用限制。
重要提示:
- 全局配置文件 (推荐): 为了安全和方便管理配置,推荐使用全局配置文件 '$HOME/.mcp/configs.json' 来配置环境变量,然后在 Claude/Cursor 中使用更简洁的 'command' 和 'args'。
- 环境变量: MCP 服务器允许通过环境变量进行配置,例如 'DEBUG' 和 'IPAPI_API_TOKEN'。你可以通过上述两种方式配置环境变量。
基本使用方法
- 启动 MCP 服务器 (通过 Claude Desktop 或 Cursor AI 启动): 根据上述配置,在 Claude Desktop 或 Cursor AI 中添加并启用该 MCP 服务器。
- 验证工具是否可用: 在 Claude 或 Cursor AI 中,检查工具菜单(通常有锤子或插件图标),确认 'get-ip-details' 工具是否已列出。
- 使用 IP 地址查询工具: 在 Claude 或 Cursor AI 的对话框中,可以使用以下指令来调用工具:
- 'give me my public IP' (查询当前设备公网 IP)
- 'analyze this IP: 8.8.8.8' (查询指定 IP 地址 8.8.8.8 的信息)
- 'get ip details for 1.1.1.1' (查询指定 IP 地址 1.1.1.1 的信息)
- ... 等等,根据 LLM 的理解能力,可以使用自然语言指令引导 LLM 调用 'get-ip-details' 工具。
CLI 命令行工具使用 (可选):
除了作为 MCP 服务器,该项目也提供了命令行工具,方便直接在终端中使用 IP 地址查询功能。
- 打开终端
- 运行命令:
- 获取帮助信息: 'npx -y aashari/boilerplate-mcp-server --help'
- 查询当前设备 IP 信息: 'npx -y aashari/boilerplate-mcp-server get-ip-details'
- 查询指定 IP 信息: 'npx -y aashari/boilerplate-mcp-server get-ip-details 8.8.8.8'
输出结果将以 JSON 格式在终端显示。
信息
分类
AI与计算