article
README
🚀 MCP 服务器
MCP 服务器是一个强大的平台,集成了多种实用工具,为用户提供便捷的服务。用户可按需调用不同工具,轻松完成特定任务。
🚀 快速开始
全局安装
在终端中运行以下命令进行全局安装:
npm install -g @nekzus/mcp-server
启动服务器
安装完成后,可以通过以下命令启动 MCP 服务器:
npx @nekzus/mcp-server
✨ 主要特性
- 多工具支持:集成多种功能模块,满足不同需求
- 输入验证:使用 Zod 进行严格的输入校验
- 错误处理:具备完善的异常捕捉和资源清理机制
- 信号处理:支持 SIGTERM 和 SIGINT 信号,实现优雅关机
📦 安装指南
克隆仓库
在终端中运行以下命令克隆项目仓库:
git clone https://github.com/nekzus/mcp-server.git
安装依赖
进入项目目录后,安装所有依赖包:
npm install
开发模式
使用以下命令启动开发服务器:
npm run dev
构建项目
运行以下命令进行项目构建:
npm run build
运行服务
构建完成后,可以使用以下命令运行服务:
npm start
💻 使用示例
简单转换工具
单位换算
功能描述
提供体积和重量单位之间的互转服务,支持多种常见单位。
支持的单位
-
体积:
- ml(毫升)
- l(升)
- cup(美国杯)
- tbsp( tablespoon)
- tsp( teaspoon)
- floz( fluid ounce)
-
重量:
- g(克)
- kg(千克)
- oz(盎司)
- lb(磅)
基础用法
// 将 1 美国杯转换为毫升
{
"value": 1,
"from": "cup",
"to": "ml"
}
返回结果
{
"result": 236.59,
"unit": "ml"
}
时间格式化
功能描述
将给定的时间戳格式化为易读的字符串。
参数要求
- 时间戳:Unix 时间戳(秒或毫秒)
基础用法
// 将 Unix 时间戳 1672598400 转换为人类可读格式
{
"timestamp": 1672598400,
"format": "YYYY-MM-DD HH:mm:ss"
}
返回结果
{
"formattedDate": "2023-01-01 00:00:00"
}
高级工具
数据统计
功能描述
对输入数据进行基本的统计分析,包括最大值、最小值、平均值和总和。
输入要求
- data: 数组形式的数据集
基础用法
// 统计数组 [1, 2, 3, 4, 5] 的基本信息
{
"data": [1, 2, 3, 4, 5]
}
返回结果
{
"maxValue": 5,
"minValue": 1,
"average": 3,
"sum": 15
}
📚 详细文档
项目结构
项目的目录结构如下:
src/
├── types/ # 类型定义文件夹
│ └── index.ts # 公共类型定义
├── utils/ # 工具函数文件夹
│ ├── cards.ts # 卡牌相关功能
│ ├── datetime.ts # 日期时间处理
│ └── schema.ts # 数据校验方案
├── tools/ # 各工具实现文件夹
│ └── index.ts # 工具注册中心
└── index.ts # 程序入口点
🔧 技术细节
- 通信协议:使用
StdioServerTransport实现进程间通信 - 数据校验:将 JSON 校验方案转换为 Zod 模型进行校验
- 类型安全:全程采用 TypeScript 进行静态类型检查
- 错误处理:具备完善的异常捕捉和资源清理机制
- 信号处理:支持 SIGTERM 和 SIGINT 信号,实现优雅关机
📄 许可证
项目遵循 MIT 许可证协议。
📞 联系方式
如需反馈或合作,请联系:
- 邮箱:support@nekzus.com
- 官网:https://mcp.nekzus.com
微信扫一扫