alpacon-mcp 0.3.1

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

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.

✨ 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"
• Multi-Workspace Support - Connect to your Alpacon workspaces with secure API authentication
• 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 in your workspace
• Get detailed system information and specifications
• Create and manage server documentation
• Multi-workspace support with API token management

📊 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://alpacon.io
   • Or if you have a specific workspace: https://alpacon.io/workspace/
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

You need to create a token configuration file with your Alpacon API tokens. The server supports multiple workspaces.

Create Token Configuration File

Step 1: Create the token file anywhere you prefer

# Example: Create in your home directory
mkdir -p ~/.config/alpacon
nano ~/.config/alpacon/tokens.json

Step 2: Add your tokens using this format

{
  "ap1": {
    "your-workspace-name": "your-api-token-from-alpacon-web-interface"
  }
}

Real Example:

{
  "ap1": {
    "production": "alpat-ABC123xyz789...",
    "staging": "alpat-DEF456uvw012...",
    "development": "alpat-GHI789rst345..."
  }
}

Step 3: Run with your token file

# Method 1: Using environment variable (recommended)
ALPACON_MCP_CONFIG_FILE=~/.config/alpacon/tokens.json uvx alpacon-mcp

# Method 2: Using command line flag
uvx alpacon-mcp --config-file ~/.config/alpacon/tokens.json

Alternative: Environment Variables (For CLI/Testing)

Instead of a config file, you can use environment variables:

# Format: ALPACON_MCP_<REGION>_<WORKSPACE>_TOKEN (currently ap1 supported)
export ALPACON_MCP_AP1_PRODUCTION_TOKEN="alpat-ABC123xyz789..."
export ALPACON_MCP_AP1_STAGING_TOKEN="alpat-DEF456uvw012..."

# Run with environment variables
uvx alpacon-mcp

4. Connect to AI Client

Claude Desktop

Add this to your Claude Desktop configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

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

Cursor IDE

Create .cursor/mcp.json in your project root:

{
  "mcpServers": {
    "alpacon": {
      "command": "uvx",
      "args": ["alpacon-mcp"],
      "env": {
        "ALPACON_MCP_CONFIG_FILE": "~/.config/alpacon/tokens.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 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

🔐 Identity and Access Management (IAM)

User Management:

• iam_users_list - List workspace IAM users with pagination
• iam_user_get - Get detailed user information
• iam_user_create - Create new users with group assignment
• iam_user_update - Update user details and group memberships
• iam_user_delete - Remove users from workspace
• iam_user_permissions_get - View effective user permissions
• iam_user_assign_role - Assign roles to users

Group & Role Management:

• iam_groups_list - List all workspace groups
• iam_group_create - Create groups with permissions
• iam_roles_list - List available roles
• iam_permissions_list - View all permissions

Advanced IAM Features:

• Workspace-level isolation for multi-tenant security
• Role-based access control (RBAC) implementation
• Group-based permission inheritance
• Comprehensive audit trails and logging

🔐 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

• 📚 Complete Documentation - Full documentation index
• 🚀 Getting Started Guide - Step-by-step setup
• ⚙️ Configuration Guide - Advanced configuration
• 🔧 API Reference - Complete tool documentation
• 💡 Usage Examples - Real-world scenarios
• 🛠️ Installation Guide - Platform-specific setup
• 🔍 Troubleshooting - Common issues and solutions

🚀 Advanced Usage

Multi-Workspace Management

# Configure tokens for multiple workspaces (ap1 region)
python -c "
from utils.token_manager import TokenManager
tm = TokenManager()
tm.set_token('ap1', 'company-prod', 'ap1-company-prod-token')
tm.set_token('ap1', 'company-staging', 'ap1-company-staging-token')
tm.set_token('ap1', 'company-dev', 'ap1-company-dev-token')
"

Custom Config File

# Use custom config file location
export ALPACON_MCP_CONFIG_FILE="/path/to/custom-tokens.json"
uvx alpacon-mcp

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
• Workspace-Based Access Control - Separate tokens per workspace 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?

• 📖 Start with our Getting Started Guide
• 🔧 Explore the API Reference
• 💬 Join our community discussions

Built with ❤️ for the Alpacon ecosystem