README
🚀 本地实用工具 MCP 服务器
本项目是一个模型上下文协议(MCP)服务器,它提供对各种本地系统实用程序的访问。借助该服务器,您可以与 Cursor 及其他兼容的 MCP 客户端配合使用,快速获取系统信息。
🚀 快速开始
本地实用工具 MCP 服务器为您提供了便捷访问本地系统实用程序的途径。通过它,您可以轻松获取时间日期、主机名、公共 IP 地址等多种系统信息。
✨ 主要特性
该服务器提供了丰富多样的实用工具,具体如下:
- 时间和日期:可获取当前本地时间和日期,支持多种格式,还能显示星期几。
- 主机名:轻松获取系统的主机名。
- 公共 IP 地址:快速获取机器的公共 IP 地址。
- 目录列表:能列出指定目录的内容。
- Node.js 版本:获取运行 MCP 服务器环境的 Node.js 版本信息。
- 端口检查器:检查特定端口上运行的进程。
- 思考工具:可记录、检索和分析开发会话中的思想。
📦 安装指南
全局安装
您可以使用以下命令进行全局安装:
pnpm add -g localutils-mcp-server
使用 npx 运行
若不想进行全局安装,也能使用 npx 直接运行服务器:
npx localutils-mcp-server
💻 使用示例
启动服务器
全局安装启动
若已完成全局安装,可使用以下命令启动服务器:
localutils-mcp
npx 启动
使用 npx 启动服务器的命令如下:
npx localutils-mcp-server
与 Cursor 配合使用
您可以在 Cursor 的设置中配置 MCP 服务器来使用它,具体步骤如下:
- 打开 Cursor 设置。
- 导航到 MCP 部分。
- 添加一个新的 MCP 服务器,配置如下:
{
"name": "localutils",
"command": "npx",
"args": ["localutils-mcp-server"]
}
使用 MCP 检查器
您可以通过运行以下命令来测试服务器:
pnpm run inspector
这将在 http://localhost:5173 启动 MCP 检查器。
可用工具
get_time_and_date
返回当前本地时间和日期的各种格式,包括本地时间、本地日期、星期几、ISO 8601 格式、Unix 时间戳。
get_hostname
返回运行 MCP 服务器的机器的主机名。
get_public_ip
返回运行 MCP 服务器的机器的公共 IP 地址。
list_directory
列出指定目录的内容。 参数:
path(字符串,必需):要列出内容的目录路径
get_node_version
返回运行 MCP 服务器环境的 Node.js 版本信息。
check_port
检查特定端口上运行的进程。 参数:
port(数字,必需):要检查的端口号
record_thought
记录一条思想内容。 参数:
thought(字符串,必需):要记录的思想内容metadata(对象,可选):包含额外元数据的对象,例如上下文信息
retrieve_thoughts
检索所有已记录的思想。
delete_thought
删除指定 ID 的思想。 参数:
id(字符串,必需):要删除的思想的唯一标识符
🔧 技术细节
开发
构建
使用以下命令进行项目构建:
pnpm run build
在开发模式下运行
若要在开发模式下运行项目,可使用以下命令:
pnpm run dev
测试
使用以下命令进行项目测试:
pnpm test
Git 工作流程
此仓库包含一个预提交钩子,该钩子会在每次提交前自动构建服务器,确保构建文件始终与仓库同步。构建文件包含在 git 仓库中,方便使用 npx 而无需先进行构建。 要设置预提交钩子,请在克隆仓库后运行:
pnpm install
这将安装依赖项并使用 Husky 设置预提交钩子。
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫