Localutils MCP Server

🚀 本地實用工具 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 服務器來使用它，具體步驟如下：

1. 打開 Cursor 設置。
2. 導航到 MCP 部分。
3. 添加一個新的 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 許可證。