使用说明
锅炉板MCP服务器
使用TypeScript的样板模型上下文协议(MCP)服务器实现。该项目演示了如何构建一个结构良好的MCP服务器,将工具和资源暴露给Claude Desktop等AI应用程序。它是开发人员构建MCP兼容服务器的起点,重点是干净的架构、自动化的工作流程和易于部署。
核心功能
- STDIO MCP服务器:专为Claude Desktop等AI客户端设计,通过模型上下文协议提供工具和资源。
- CLI支持:具有相同功能的人性化命令行界面,使其易于直接测试和使用。
- IP地址查找:获取有关任何IP地址或当前设备IP的详细信息。
- 自动化发布管理:GitHub Actions工作流,用于持续集成、测试和发布到GitHub包。
安装
全球安装
您可以全局安装此软件包以用作CLI工具:
npm install -g @aashari/boilerplate-mcp-server
全局安装后,您可以直接运行CLI命令:
# Get help
boilerplate-mcp-server --help
# Get current IP details
boilerplate-mcp-server get-ip-details
# Get details for a specific IP
boilerplate-mcp-server get-ip-details 8.8.8.8
本地安装
对于开发或本地使用,克隆存储库并安装依赖项:
git clone https://github.com/aashari/boilerplate-mcp-server.git
cd boilerplate-mcp-server
npm install
然后运行开发服务器:
npm run dev
或者构建并启动:
npm run build
npm start
终端用户的配置选项
在设置Claude Desktop或Cursor AI之前,您可以配置服务器。为最终用户推荐了两个选项:
选项1:在Claude/Cursor中直接配置
直接在Claude Desktop配置或Cursor AI命令中传递您的配置:
{
"mcpServers": {
"aashari/boilerplate-mcp-server": {
"command": "npx",
"args": ["-y", "DEBUG=true", "IPAPI_API_TOKEN=your_token", "aashari/boilerplate-mcp-server"]
}
}
}
选项2:全局配置文件(推荐)
- 在以下位置创建全局配置文件
$HOME/.mcp/configs.json:
{
"@aashari/boilerplate-mcp-server": {
"environments": {
"DEBUG": "true",
"IPAPI_API_TOKEN": "your_token"
}
}
}
- 然后在Claude Desktop或Cursor AI中使用简化配置:
{
"mcpServers": {
"aashari/boilerplate-mcp-server": {
"command": "npx",
"args": ["-y", "aashari/boilerplate-mcp-server"]
}
}
}
这种方法将您的配置保存在一个安全的位置,并简化了您的AI助手设置。
可用配置选项
- 调试:设置为
true以启用调试日志记录。 - PI API令牌:IP API服务的API令牌(如果需要)。
使用Claude Desktop进行设置
要将此MCP服务器与Claude Desktop一起使用:
-
打开克劳德桌面设置:
- 启动克劳德桌面
- 点击右上角的设置图标(齿轮)
-
编辑MCP配置:
- 点击“编辑配置”按钮
- 这将打开文件资源管理器/查找器
claude_desktop_config.json文件
-
更新配置文件:
- 将上述配置选项之一添加到文件中
- 保存文件
已设置全局配置文件的示例:
{ "mcpServers": { "aashari/boilerplate-mcp-server": { "command": "npx", "args": ["-y", "aashari/boilerplate-mcp-server"] } } } -
重新启动克劳德桌面:
- 关闭并重新打开Claude Desktop以应用更改
-
验证工具可用性:
- 在Claude主页上,寻找右侧的锤子图标
- 单击它查看可用工具
- 确保
get-ip-details工具已列出
-
测试工具:
- 试着问克劳德:“给我我的公共IP”或“分析这个IP:8.8.8.8”
- Claude将使用MCP工具获取并显示所请求的信息
使用Cursor AI进行设置
要将此MCP服务器与Cursor AI一起使用:
-
打开光标设置:
- 启动光标
- 按
CMD + SHIFT + P(或CTRL + SHIFT + P在Windows上) - 键入“设置”并选择“光标设置”
- 在侧栏上,选择“MCP”
-
添加新的MCP服务器:
- 点击“+添加新的MCP服务器”
- 将出现一个配置表单
-
配置MCP服务器:
- 名字:输入
aashari/boilerplate-mcp-server - 类型:选择
command从下拉列表中 - 命令:根据您的配置方法选择以下选项之一:
如果使用全局配置文件(推荐):
npx -y aashari/boilerplate-mcp-server如果直接传递配置:
DEBUG=true IPAPI_API_TOKEN=your_token npx -y aashari/boilerplate-mcp-server- 点击“添加”
- 名字:输入
-
验证服务器配置:
- 服务器现在应该以绿色指示器列出
- 你应该看看
get_ip_details服务器下列出的工具
-
测试工具:
- 在聊天侧边栏中,确保代理模式处于活动状态
- 试着问:“给我我的公共IP”或“分析此IP:8.8.8.8”
- Cursor AI将使用MCP工具获取并显示所请求的信息
用作CLI工具
该软件包还可以用作人机交互的命令行工具:
-
获取帮助和可用命令:
npx -y aashari/boilerplate-mcp-server --help输出示例:
Usage: @aashari/boilerplate-mcp-server [options] [command] A boilerplate Model Context Protocol (MCP) server implementation using TypeScript Options: -V, --version output the version number -h, --help display help for command Commands: get-ip-details [ipAddress] Get details about a specific IP address or the current device help [command] display help for command -
获取当前设备IP详细信息:
npx -y aashari/boilerplate-mcp-server get-ip-details输出示例:
status: success country: Indonesia countryCode: ID region: JK regionName: Jakarta city: Jakarta zip: 11730 lat: -6.2114 lon: 106.8446 timezone: Asia/Jakarta isp: Biznet Wifi org: as: AS17451 BIZNET NETWORKS query: 118.99.106.135- 获取特定IP地址的详细信息:
npx -y aashari/boilerplate-mcp-server get-ip-details 8.8.8.8输出示例:
status: success country: United States countryCode: US region: VA regionName: Virginia city: Ashburn zip: 20149 lat: 39.03 lon: -77.5 timezone: America/New_York isp: Google LLC org: Google Public DNS as: AS15169 Google LLC query: 8.8.8.8
关于MCP
有关模型上下文协议(MCP)的详细信息,包括核心概念、架构和实现指南,请参阅 MCP官方文件.
对于开发者
如果您有兴趣开发或扩展此项目,请参阅 开发指南 有关以下内容的详细信息:
- 先决条件和安装
- 项目结构
- 配置系统
- 添加自己的功能
- 测试和部署
- 创建自己的MCP服务器
- 还有更多
