Env MCP

🚀 env-mcp Toolkit Documentation

env-mcp is a toolkit for retrieving system and network environment information. It offers various functions to help developers quickly obtain detailed system configuration and status information.

🚀 Quick Start

env-mcp is a powerful toolkit that simplifies the process of gathering system and network environment details. With just a few steps, you can integrate it into your project and start leveraging its features.

✨ Features

• Retrieve system platform information
• Obtain memory usage
• Get CPU information
• Fetch network interface details
• Retrieve user information
• Determine the terminal type
• Obtain IPv4 and IPv6 address information
• Get proxy settings
• Retrieve USB device details
• Obtain printer information
• Get SSH public keys
• Retrieve Docker information
• Obtain Node.js version information

📦 Installation

# Install the toolkit
npm install env-mcp

# After installation, you can use the toolkit in your project

💻 Usage Examples

Basic Usage

Configure the MCP Service

Integrate the MCP service into your application:

1. Import the MCP client:

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

2. Initialize the MCP instance:

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

Call Example

Get the system platform information:

mcpClient.getPlatformInfo((error, result) => {
  if (error) {
    console.error('Failed to get platform information:', error);
  } else {
    console.log('Platform information:', result);
  }
});

Advanced Usage

Tool List and Function Descriptions

Get System Platform Information

• Function: getPlatformInfo()
• Return Value:

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

Get Memory Usage

• Function: getMemoryUsage()
• Return Value:

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

📚 Documentation

Development Guide

# Install project dependencies
npm install

# Start the development server (supports automatic restart)
npm run dev

# Build the production package
npm run build

# Start the built application
npm start

Environment Variable Configuration

Configure runtime parameters through the .env file:

• PORT: The port number the service listens on, default is 3000.
• NODE_ENV: The runtime environment mode, available values are development or production.

📄 License

This project is licensed under the ISC license.