Env MCP

🚀 env-mcp 工具包文檔

env-mcp 是一款強大的工具包，專為開發者設計，可快速獲取系統和網絡環境的詳細信息。它提供了豐富的功能，助力開發者高效掌握系統的配置與狀態。

🚀 快速開始

env-mcp 工具包能讓你輕鬆獲取系統和網絡環境信息。按以下步驟操作，即可快速上手：

# 安裝工具包
npm install env-mcp

# 安裝完成後，您可以在項目中使用該工具包

✨ 主要特性

• 🌐 獲取系統的平臺信息
• 💾 獲取內存使用情況
• 🖥️ 獲取 CPU 信息
• 🌐 獲取網絡接口信息
• 👤 獲取用戶信息
• 💻 獲取終端類型
• 🌐 獲取 IPv4 和 IPv6 地址信息
• 🔌 獲取代理設置
• 🖫 獲取 USB 設備信息
• 🖨️ 獲取打印機信息
• 🔑 獲取 SSH 公鑰
• 🐳 獲取 Docker 信息
• 🟢 獲取 Node.js 版本信息

📦 安裝指南

# 安裝工具包
npm install env-mcp

# 安裝完成後，您可以在項目中使用該工具包

💻 使用示例

基礎用法

配置 MCP 服務

在您的應用中集成 MCP 服務：

1. 引入 MCP 客戶端：

const mcp = require('env-mcp');

2. 初始化 MCP 實例：

const mcpClient = new mcp.Client({
  port: process.env.PORT || 3000,
  host: 'localhost'
});

調用示例

獲取系統平臺信息：

mcpClient.getPlatformInfo((error, result) => {
  if (error) {
    console.error('獲取平臺信息失敗:', error);
  } else {
    console.log('平臺信息:', result);
  }
});

工具列表及功能描述

獲取系統平臺信息

• 函數: getPlatformInfo()
• 返回值:

  {
    platform: string,
    arch: string,
    hostname: string,
    type: string,
    release: string,
    version: string
  }
  

獲取內存使用情況

• 函數: getMemoryUsage()
• 返回值:

  {
    totalMemory: number,
    freeMemory: number,
    usedMemory: number
  }
  

📚 詳細文檔

開發指南

# 安裝項目依賴
npm install

# 啟動開發服務器（支持自動重啟）
npm run dev

# 構建生產環境包
npm run build

# 啟動構建後的應用
npm start

環境變量配置

通過 .env 文件配置運行時參數：

• PORT: 服務監聽的端口號，默認為 3000。
• NODE_ENV: 運行環境模式，可選值為 development 或 production。

📄 許可證

本項目遵循 ISC 許可證協議。