使用说明
项目简介
personal-mcp-server 是一个使用 TypeScript 构建的 Model Context Protocol (MCP) 服务器的样板项目。它旨在帮助开发者快速搭建能够为 AI 应用(如 Claude Desktop 和 Cursor AI)提供工具和资源的 MCP 服务器。该项目结构清晰,自动化工作流完善,易于部署,是构建 MCP 兼容服务器的理想起点。
主要功能点
- STDIO MCP 服务器: 通过标准的输入输出流 (STDIO) 与 AI 客户端(如 Claude Desktop)通信,提供工具和资源。
- 命令行界面 (CLI): 除了作为 MCP 服务器运行,也提供友好的命令行界面,方便用户直接测试和使用 IP 地址查询功能。
- IP 地址查询: 提供查询 IP 地址详细信息的功能,可以查询指定 IP 地址,也可以查询当前设备的公网 IP 地址。
安装步骤
全局安装 (作为 CLI 工具使用):
- 确保已安装 Node.js 和 npm。
- 打开终端,运行以下命令进行全局安装:
npm install -g @aashari/boilerplate-mcp-server
本地安装 (用于开发或本地服务器运行):
- 确保已安装 Node.js 和 npm。
- 打开终端,使用 git 克隆仓库到本地:
git clone https://github.com/aashari/aashari/boilerplate-mcp-server.git cd boilerplate-mcp-server - 安装项目依赖:
npm install
服务器配置
本 MCP 服务器主要通过 STDIO 协议与客户端通信。以下是配置 Claude Desktop 或 Cursor AI 连接到此 MCP 服务器的配置信息(JSON 格式)。 请注意,以下配置信息是用于 MCP 客户端 (如 Claude Desktop, Cursor AI) 的,不是直接在服务器上运行的代码。
推荐配置 (使用全局配置文件):
如果您希望更安全和方便地管理配置,推荐使用全局配置文件。
- 创建全局配置文件:在用户Home目录下创建 '.mcp' 文件夹,并在其中创建 'configs.json' 文件。文件完整路径例如:'$HOME/.mcp/configs.json'。
- 编辑 'configs.json' 文件,添加以下 JSON 内容。请将 'your_token' 替换为您自己的 IP API 服务的 API 令牌 (如果需要)。如果您不需要使用IP API服务,或者不希望设置API Token,可以删除 '"IPAPI_API_TOKEN": "your_token"' 这一行。
{ "@aashari/boilerplate-mcp-server": { "environments": { "DEBUG": "true", // 设置为 true 启用调试日志 (可选) "IPAPI_API_TOKEN": "your_token" // IP API 服务的 API 令牌 (可选) } } } - 在 Claude Desktop 或 Cursor AI 的 MCP 服务器配置中,添加以下 JSON 内容。
{ "mcpServers": { "aashari/boilerplate-mcp-server": { "command": "npx", // 运行命令,这里使用 npx 来执行本地安装的 npm 包 "args": ["-y", "aashari/boilerplate-mcp-server"] // 命令参数,-y 表示跳过 npm 提示, aashari/boilerplate-mcp-server 是要执行的包名 } } }
基本配置 (直接在客户端配置命令和参数):
如果您不想使用全局配置文件,也可以直接在 Claude Desktop 或 Cursor AI 的 MCP 服务器配置中,添加以下 JSON 内容。 同样,请将 'your_token' 替换为您自己的 IP API 服务的 API 令牌 (如果需要)。
{ "mcpServers": { "aashari/boilerplate-mcp-server": { "command": "npx", "args": ["-y", "DEBUG=true", "IPAPI_API_TOKEN=your_token", "aashari/boilerplate-mcp-server"] // 所有配置信息都直接通过参数传递 } } }
基本使用方法
作为 MCP 服务器 (配合 Claude Desktop 或 Cursor AI):
- 按照 "服务器配置" 步骤配置 Claude Desktop 或 Cursor AI。
- 启动 Claude Desktop 或 Cursor AI。
- 在 Claude 或 Cursor 中,你可以向 AI 助手提问,例如:
- "我的公网 IP 地址是多少?"
- "分析一下 IP 地址 8.8.8.8 的信息。"
- AI 助手将调用 'get-ip-details' 工具来获取 IP 地址信息并返回给你。
作为 CLI 工具 (直接在终端使用):
- 全局安装后,在终端中可以直接使用 'boilerplate-mcp-server' 命令。本地安装后,需要在项目根目录下使用 'npx -y aashari/boilerplate-mcp-server' 命令。
- 获取帮助信息: 运行 'boilerplate-mcp-server --help' 或 'npx -y aashari/boilerplate-mcp-server --help' 查看可用命令和选项。
- 查询当前设备 IP 信息: 运行 'boilerplate-mcp-server get-ip-details' 或 'npx -y aashari/boilerplate-mcp-server get-ip-details'。
- 查询指定 IP 地址信息: 运行 'boilerplate-mcp-server get-ip-details <IP地址>' 或 'npx -y aashari/boilerplate-mcp-server get-ip-details <IP地址>',例如 'boilerplate-mcp-server get-ip-details 8.8.8.8'。
信息
分类
AI与计算