Skip to main content

AI-Powered Server Management - Connect Claude, Cursor, and other AI tools directly to your Alpacon infrastructure

Project description

Alpacon MCP Server

๐Ÿš€ AI-Powered Server Management - Connect Claude, Cursor, and other AI tools directly to your Alpacon infrastructure

An advanced MCP (Model Context Protocol) server that bridges AI assistants with Alpacon's server management platform, enabling natural language server administration, monitoring, and automation.

Python Version MCP Compatible License

โœจ What is Alpacon MCP Server?

The Alpacon MCP Server transforms how you interact with your server infrastructure by connecting AI assistants directly to Alpacon's management platform. Instead of switching between interfaces, you can now manage servers, monitor metrics, execute commands, and troubleshoot issues using natural language.

๐ŸŽฏ Key Benefits

  • Natural Language Server Management - "Show me CPU usage for all web servers in production"
  • AI-Powered Troubleshooting - "Investigate why server-web-01 is slow and suggest fixes"
  • Unified Multi-Region Control - Manage servers across AP1, US1, EU1 regions seamlessly
  • Real-Time Monitoring Integration - Access metrics, logs, and events through AI conversations
  • Secure WebSH & File Operations - Execute commands and transfer files via AI interface

๐ŸŒŸ Core Features

๐Ÿ–ฅ๏ธ Server Management

  • List and monitor servers across regions
  • Get detailed system information and specifications
  • Create and manage server documentation
  • Multi-workspace and multi-region support

๐Ÿ“Š Real-Time Monitoring

  • CPU, memory, disk, and network metrics
  • Performance trend analysis
  • Top server identification
  • Custom alert rule management
  • Comprehensive health dashboards

๐Ÿ’ป System Administration

  • User and group management
  • Package inventory and updates
  • Network interface monitoring
  • Disk and partition analysis
  • System time and uptime tracking

๐Ÿ”ง Remote Operations

  • WebSH sessions for secure shell access
  • Command execution with real-time output
  • File upload/download via WebFTP
  • Session management and monitoring

๐Ÿ“‹ Event Management

  • Command acknowledgment and tracking
  • Event search and filtering
  • Execution history and status
  • Automated workflow coordination

๐Ÿš€ Quick Start

1. Installation

Option A: Using uvx (Recommended)

# Install UV first (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Run directly without installation
uvx alpacon-mcp --help

# Run with configuration
uvx alpacon-mcp --config-file /path/to/config.json

Option B: Traditional Installation

# Install from PyPI
pip install alpacon-mcp

# Or using UV
uv tool install alpacon-mcp

# Run the server
alpacon-mcp

Option C: Development Installation

# Clone and setup for development
git clone https://github.com/alpacax/alpacon-mcp.git
cd alpacon-mcp
uv venv && source .venv/bin/activate
uv pip install -e .

2. Get API Token from Alpacon

  1. Visit your Alpacon workspace: https://workspace.region.alpacon.io
    • Example: https://production.ap1.alpacon.io
  2. Log in to your account
  3. Click "API Token" in the left sidebar
  4. Create a new token or copy existing token
  5. Configure Token Permissions (ACL):
    • Click on the generated token to open details
    • Configure Access Control List (ACL) settings
    • Important: Command execution requires specific ACL permissions
    • Set allowed commands, servers, and operations as needed
  6. Save the token securely

3. Configure Authentication

Option A: Using Configuration File (Recommended for MCP Clients)

# Create configuration file
mkdir -p ~/.config/alpacon
echo '{
  "ap1": {
    "production": "your-production-token",
    "staging": "your-staging-token"
  },
  "us1": {
    "backup": "your-us-token"
  }
}' > ~/.config/alpacon/tokens.json

# Run with uvx using config file
ALPACON_MCP_CONFIG_FILE=~/.config/alpacon/tokens.json uvx alpacon-mcp

Option B: Using Environment Variables (For CLI/Testing)

# Set environment variables for direct usage
export ALPACON_MCP_AP1_PRODUCTION_TOKEN="your-production-token"
export ALPACON_MCP_AP1_STAGING_TOKEN="your-staging-token"
export ALPACON_MCP_US1_BACKUP_TOKEN="your-us-token"

# Run with uvx using environment variables
uvx alpacon-mcp

4. Connect to AI Client

Claude Desktop

{
  "mcpServers": {
    "alpacon": {
      "command": "uvx",
      "args": ["alpacon-mcp"],
      "env": {
        "ALPACON_MCP_CONFIG_FILE": "/path/to/your/alpacon-tokens.json"
      }
    }
  }
}

Cursor IDE

{
  "mcpServers": {
    "alpacon": {
      "command": "uvx",
      "args": ["alpacon-mcp"],
      "env": {
        "ALPACON_MCP_CONFIG_FILE": "./config/token.json"
      }
    }
  }
}

๐Ÿ’ฌ Usage Examples

Server Health Monitoring

"Give me a comprehensive health check for server web-01 including CPU, memory, and disk usage for the last 24 hours"

Performance Analysis

"Show me the top 5 servers with highest CPU usage and analyze performance trends"

System Administration

"List all users who can login on server web-01 and check for any users with sudo privileges"

Automated Troubleshooting

"Server web-01 is responding slowly. Help me investigate CPU, memory, disk I/O, and network usage to find the bottleneck"

Command Execution

"Execute 'systemctl status nginx' on server web-01 and check the service logs"

File Management

"Upload my config.txt file to /home/user/ on server web-01 and then download the logs folder as a zip"

Persistent Shell Sessions

"Create a persistent shell connection to server web-01 and run these commands: check disk usage, list running processes, and create a backup directory"

๐Ÿ”ง Available Tools

๐Ÿ–ฅ๏ธ Server Management

  • servers_list - List all servers in region/workspace
  • server_get - Get detailed server information
  • server_notes_list - View server documentation
  • server_note_create - Create server notes

๐Ÿ“Š Monitoring & Metrics

  • get_cpu_usage - CPU utilization metrics
  • get_memory_usage - Memory consumption data
  • get_disk_usage - Disk space and I/O metrics
  • get_network_traffic - Network bandwidth usage
  • get_server_metrics_summary - Comprehensive health overview
  • get_cpu_top_servers - Identify performance leaders

๐Ÿ’ป System Information

  • get_system_info - Hardware specifications and details
  • get_os_version - Operating system information
  • list_system_users - User account management
  • list_system_groups - Group membership details
  • list_system_packages - Installed software inventory
  • get_network_interfaces - Network configuration
  • get_disk_info - Storage device information

๐Ÿ”ง Remote Operations

WebSH (Shell Access)

  • websh_session_create - Create secure shell sessions
  • websh_command_execute - Execute single commands
  • websh_websocket_execute - Single command via WebSocket
  • websh_channel_connect - Persistent connection management
  • websh_channel_execute - Execute commands using persistent channels
  • websh_channels_list - List active WebSocket channels
  • websh_session_terminate - Close sessions

WebFTP (File Management)

  • webftp_upload_file - Upload files using S3 presigned URLs
  • webftp_download_file - Download files/folders (folders as .zip)
  • webftp_uploads_list - Upload history
  • webftp_downloads_list - Download history
  • webftp_sessions_list - Active FTP sessions

๐Ÿ“‹ Event Management

  • list_events - Browse server events and logs
  • search_events - Find specific events
  • acknowledge_command - Confirm command receipt
  • finish_command - Mark commands as complete

๐Ÿ” Authentication

  • auth_set_token - Configure API tokens
  • auth_remove_token - Remove stored tokens

๐ŸŒ Supported Platforms

Platform Status Notes
Claude Desktop โœ… Full Support Recommended client
Cursor IDE โœ… Full Support Native MCP integration
VS Code โœ… Full Support Requires MCP extension
Continue โœ… Full Support Via MCP protocol
Other MCP Clients โœ… Compatible Standard protocol support

๐Ÿ“– Documentation

๐Ÿš€ Advanced Usage

Multi-Region Management

# Configure tokens for multiple regions
python -c "
from utils.token_manager import TokenManager
tm = TokenManager()
tm.set_token('ap1', 'company-prod', 'ap1-company-prod-token')
tm.set_token('us1', 'backup-site', 'us1-backup-token')
tm.set_token('eu1', 'company-eu', 'eu1-company-token')
"

Custom Config File

# Use custom config file location
export ALPACON_CONFIG_FILE="/path/to/custom-tokens.json"
python main.py

Docker Deployment

# Build and run with Docker
docker build -t alpacon-mcp .
docker run -v $(pwd)/config:/app/config:ro alpacon-mcp

SSE Mode (HTTP Transport)

# Run in Server-Sent Events mode for web integration
python main_sse.py
# Server available at http://localhost:8237

๐Ÿ”’ Security & Best Practices

  • Secure Token Storage - Tokens encrypted and never committed to git
  • Region-Based Access Control - Separate tokens per environment
  • ACL Configuration Required - Configure token permissions in Alpacon web interface for command execution
  • Audit Logging - All operations logged for security review
  • Connection Validation - API endpoints verified before execution

โš ๏ธ Command Execution Limitations

Important: WebSH and command execution tools can only run pre-approved commands configured in your token's ACL settings:

  1. Visit token details in Alpacon web interface (click on your token)
  2. Configure ACL permissions for allowed commands, servers, and operations
  3. Commands not in ACL will be rejected with 403/404 errors
  4. Contact your administrator if you need additional command permissions

๐Ÿค Contributing

We welcome contributions! Please see our Contributing Guide for details.

  • ๐Ÿ› Bug Reports - Use GitHub issues
  • ๐Ÿ’ก Feature Requests - Open discussions
  • ๐Ÿ“ Documentation - Help improve guides
  • ๐Ÿ”ง Code Contributions - Submit pull requests

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


Ready to transform your server management experience?

Built with โค๏ธ for the Alpacon ecosystem

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alpacon_mcp-0.1.1.tar.gz (93.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alpacon_mcp-0.1.1-py3-none-any.whl (124.1 kB view details)

Uploaded Python 3

File details

Details for the file alpacon_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: alpacon_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 93.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for alpacon_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 40af132ce346e9c8a99f5fedb3188f666cd678c0e9be13fccfae4bb4313ba1c1
MD5 16ce9534587970852f651f3b03face56
BLAKE2b-256 b73662c580f46df1f55941751181dfdfb7f6b1806a7ae92a18b5d6938d95ea8b

See more details on using hashes here.

Provenance

The following attestation bundles were made for alpacon_mcp-0.1.1.tar.gz:

Publisher: publish.yml on alpacax/alpacon-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file alpacon_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: alpacon_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 124.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for alpacon_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 66760030e5f5e861b12a08d7b010bd6b07c2f54e2d18b04ccf57d24c78fdf816
MD5 b3e40bb777e517194f02f2c05ebe3b2b
BLAKE2b-256 816670c9af880fa8795e5aec6b6ef2e4278ab8408f5391026dee7428afc58558

See more details on using hashes here.

Provenance

The following attestation bundles were made for alpacon_mcp-0.1.1-py3-none-any.whl:

Publisher: publish.yml on alpacax/alpacon-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page