Uses the Apache 2.0 license for its code, allowing for open-source distribution and modification with appropriate attribution.
Runs on Node.js runtime, enabling server-side JavaScript execution for Windows system management capabilities.
Utilizes Shields.io for generating status badges in the documentation, displaying version, download counts, and other project metadata.
The MCP server is built with TypeScript, providing type safety and modern JavaScript features for its implementation.
🖥️ Windows System MCP
A comprehensive Model Context Protocol (MCP) server that provides AI models with powerful Windows system management capabilities. This MCP enables AI assistants to interact with Windows systems through a secure, well-structured interface.
✨ Features
📁 File System Management
Directory Browsing: Navigate and explore directory structures
File Operations: Read files, get file information, and search for files
Disk Analysis: Monitor disk usage and find large files
Advanced Search: Pattern-based file searching with recursive options
⚙️ Process Management
Process Monitoring: List and monitor running processes
Resource Tracking: Track CPU and memory usage by process
Process Control: Start, stop, and manage processes
Process Tree: Visualize parent-child process relationships
🔧 System Information
Hardware Details: CPU, memory, disk, and network adapter information
OS Information: Windows version, updates, and system configuration
Environment: Environment variables and system paths
User Management: User accounts and current user information
📋 Registry Operations
Registry Reading: Access Windows registry keys and values
System Configuration: Retrieve system settings from registry
Startup Programs: List programs that start with Windows
Installed Software: Enumerate installed applications
🛠️ Service Management
Service Control: Start, stop, and restart Windows services
Service Monitoring: Monitor service status and dependencies
Startup Services: Manage services that start automatically
Service Search: Find services by name or description
🌐 Network Operations
Network Diagnostics: Ping, traceroute, and connectivity testing
Port Scanning: Check open ports and network connections
Network Configuration: View adapters, IP configuration, and routing
WiFi Management: List and manage WiFi profiles
📊 Performance Monitoring
Real-time Metrics: CPU, memory, disk, and network performance
Resource Analysis: Identify top resource-consuming processes
Performance Counters: Access Windows performance counters
System Health: Monitor overall system performance
📥 Installation
🚀 Quick Start
Prerequisites
Windows 10/11
Node.js 18+
PowerShell 5.1+
Installation Options
Option 1: Install from NPM (Recommended)
Option 2: Build from Source
Clone the repository:
git clone https://github.com/guangxiangdebizi/windows-system-mcp.git cd windows-system-mcpInstall dependencies:
npm installBuild the project:
npm run build
Local Development (Stdio)
If installed globally:
If built from source:
Development
For development with auto-rebuild:
SSE Deployment (Supergateway)
If installed globally:
If built from source:
This will start the server on http://localhost:3100/sse
🔧 Configuration
Claude Desktop Integration
Stdio Configuration
If installed globally:
If built from source:
SSE Configuration
Note: For SSE mode, start the server first using the commands shown in the deployment section above.
📖 Usage Examples
File System Operations
Process Management
System Information
Network Operations
🛡️ Security Considerations
Principle of Least Privilege: Run with minimal required permissions
Input Validation: All inputs are validated and sanitized
Safe Operations: Read-only operations are prioritized
Error Handling: Comprehensive error handling prevents system exposure
Audit Trail: All operations can be logged for security auditing
🤝 Contributing
We welcome contributions! Please see our Contributing Guidelines for details.
Development Setup
Fork the repository
Create a feature branch:
git checkout -b feature/amazing-feature
Make your changes
Add tests if applicable
Commit your changes:
git commit -m 'Add amazing feature'
Push to the branch:
git push origin feature/amazing-feature
Open a Pull Request
📄 License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
🔗 Links
NPM Package: https://www.npmjs.com/package/windows-system-mcp
GitHub: https://github.com/guangxiangdebizi/windows-system-mcp
Author: Xingyu Chen
Email: guangxiangdebizi@gmail.com
NPM Profile: https://www.npmjs.com/~xingyuchen
👨💻 Author
Xingyu Chen
🌐 Website: GitHub Profile
📧 Email: guangxiangdebizi@gmail.com
💼 LinkedIn: Xingyu Chen
📦 NPM: @xingyuchen
🙏 Acknowledgments
Model Context Protocol for the excellent MCP framework
The Windows PowerShell team for providing powerful system management capabilities
The TypeScript and Node.js communities for excellent tooling
📊 Project Stats
NPM Package: Available as
windows-system-mcp
Language: TypeScript
Runtime: Node.js
Platform: Windows
License: Apache 2.0
MCP Version: 0.6.0
local-only server
The server can only run on the client's local machine because it depends on local resources.
A comprehensive Model Context Protocol server that enables AI assistants to interact with and manage Windows systems, providing capabilities for file system operations, process management, system information retrieval, registry operations, service management, network diagnostics, and performance monitoring.
Related MCP Servers
- AsecurityAlicenseAqualityA Model Context Protocol server that provides programmatic access to the Windows terminal, enabling AI models to interact with the Windows command line through standardized tools for writing commands, reading output, and sending control signals.Last updated -3MIT License
- -securityFlicense-qualityA versatile Model Context Protocol server that enables AI assistants to manage calendars, track tasks, handle emails, search the web, and control smart home devices.Last updated -18
- -securityFlicense-qualityA comprehensive Model Context Protocol server implementation that enables AI assistants to interact with file systems, databases, GitHub repositories, web resources, and system tools while maintaining security and control.Last updated -331
- AsecurityAlicenseAqualityA secure Model Context Protocol server that allows AI models to safely interact with Windows command-line functionality, enabling controlled execution of system commands, project creation, and system information retrieval.Last updated -87MIT License
Appeared in Searches
- MCP servers for retrieving system information
- MCP servers for monitoring power and memory usage of applications on Windows and macOS
- MCP servers for monitoring application power and memory usage on Windows and macOS
- Creating a Web API, VSIX Extension, and WPF Application
- Information about Microsoft technologies