Skip to content

Releases: Nino6689/zyxel-mcp-server

Release list

Initial Release - Zyxel Switch MCP Server v1.0.0

Initial Release - Zyxel Switch MCP Server v1.0.0 Latest
Latest

Choose a tag to compare

View all tags
@Nino6689 Nino6689 released this 04 Nov 20:01
v1.0.0
096735b

Changelog

All notable changes to the Zyxel Switch MCP Server will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

[1.0.0] - 2024-11-04

Added

Core MCP Framework

  • Complete Model Context Protocol (MCP) server implementation
  • Support for MCP SDK v1.0.3
  • Three-pillar MCP architecture: Tools, Resources, and Prompts
  • TypeScript implementation with strict typing and error handling

CLI Command Integration

  • Real Zyxel CLI commands extracted from 407-page official documentation
  • Authentic command syntax for GS1920, GS1900, XGS1930, XGS2220 series
  • Production-ready command response formats
  • Support for firmware versions 3.79-4.60

MCP Tools (20+ available)

  • Connection Management: zyxel_connect, zyxel_disconnect, zyxel_connection_status
  • System Operations: zyxel_show_version, zyxel_show_system_info, zyxel_show_running_config
  • Interface Management: zyxel_show_interfaces, zyxel_configure_interface, zyxel_configure_switchport
  • VLAN Operations: zyxel_show_vlan, zyxel_create_vlan, zyxel_delete_vlan
  • Network Monitoring: zyxel_show_mac_table, zyxel_show_arp_table, zyxel_show_spanning_tree
  • Diagnostic Tools: zyxel_ping, zyxel_traceroute
  • Configuration Management: zyxel_save_config, zyxel_execute_cli

MCP Resources (12 available)

  • System Resources: Version information, running configuration, startup configuration
  • Network Resources: Interface status, VLAN configuration, MAC address table, ARP table
  • Monitoring Resources: System logs, spanning tree status, LLDP neighbors
  • Security Resources: User authentication, access control lists
  • Documentation: Complete CLI command reference

MCP Prompts (8 available)

  • Setup Workflows: Initial switch setup, VLAN configuration
  • Troubleshooting: Interface diagnostics, connectivity issues
  • Security: Authentication setup, access control configuration
  • Maintenance: Configuration backup, system monitoring

Authentic Zyxel CLI Support

  • System Commands: show system-information, show version, show running-config
  • Interface Commands: show interfaces, interface port-channel, switchport mode
  • VLAN Commands: show vlan, vlan <id>, switchport access vlan
  • Monitoring Commands: show mac address-table, show ip arp, show spanning-tree
  • Security Commands: show aaa authentication, show logging, show snmp

Documentation and Examples

  • Comprehensive README with installation and usage instructions
  • Detailed installation guide (INSTALL.md)
  • Extensive usage examples (EXAMPLES.md) with 39 real-world scenarios
  • Contributing guidelines (CONTRIBUTING.md) for developers
  • CLI integration status documentation

Development Tools

  • TypeScript configuration with strict mode
  • NPM scripts for building, development, and testing
  • VS Code task configuration
  • Git repository setup with appropriate .gitignore

Technical Details

Architecture

  • Framework: Model Context Protocol (MCP) with TypeScript SDK
  • Language: TypeScript 5.0+ with ES2022 modules
  • Dependencies: @modelcontextprotocol/sdk, zod for validation
  • Build System: TypeScript compiler with npm scripts

Supported Hardware

  • Zyxel GS1920 Series (24/48 port variants)
  • Zyxel GS1900 Series managed switches
  • Zyxel XGS1930 Series
  • Zyxel XGS2220 Series
  • Other managed Zyxel switches with CLI access via SSH

Key Features

  • ✅ Production-ready CLI command implementation
  • ✅ Real Zyxel command syntax and response parsing
  • ✅ Comprehensive error handling and validation
  • ✅ Type-safe TypeScript implementation
  • ✅ Complete MCP protocol compliance
  • ✅ Extensive documentation and examples

Documentation Extracted From

  • Source: Zyxel Ethernet Switch CLI Reference Guide
  • Versions: 3.79, 3.80, 3.90, 4.00, 4.10, 4.20, 4.30, 4.40, 4.50, 4.60
  • Edition: 2, 05/2019
  • Pages: 407 pages of comprehensive CLI documentation

Future Releases

Planned Features for v1.1.0

  • Unit test suite with Jest
  • Configuration validation tools
  • Advanced SNMP integration
  • Web UI for switch management
  • Support for additional Zyxel models

Planned Features for v1.2.0

  • Multi-switch management
  • Configuration templating system
  • Network topology discovery
  • Performance monitoring and alerting

Release Notes

Version 1.0.0 - Initial Release

This is the first public release of the Zyxel Switch MCP Server. The server provides comprehensive support for Zyxel switch management through the Model Context Protocol, enabling AI applications to interact naturally with network infrastructure.

Key Highlights:

  • Complete MCP framework implementation with 40+ tools, resources, and prompts
  • Real Zyxel CLI commands extracted from official 407-page documentation
  • Support for major Zyxel switch series (GS1920, GS1900, XGS1930, XGS2220)
  • Production-ready with comprehensive error handling and TypeScript safety
  • Extensive documentation with 39 usage examples

Target Users:

  • Network administrators using AI-powered management tools
  • Developers building network automation solutions
  • Organizations implementing MCP-based infrastructure management
  • Teams requiring programmatic Zyxel switch control

Getting Started:

  1. Clone the repository
  2. Run npm install && npm run build
  3. Configure your MCP client to connect to the server
  4. Start managing your Zyxel switches with natural language commands

Community:
We welcome contributions! See CONTRIBUTING.md for development guidelines and how to get involved.

Assets 2
Loading