Quick Start Guide

Get up and running with AvaloniaUI.MCP in minutes.

Prerequisites

Before you begin, ensure you have:

• .NET 9.0 SDK or later
• MCP-compatible client such as:
  • Claude Desktop
  • VS Code with MCP extension
  • Custom MCP client

Installation

1. Clone the Repository

git clone https://github.com/decriptor/AvaloniaUI.MCP.git
cd AvaloniaUI.MCP

2. Build the Project

dotnet build

3. Run Tests (Optional)

dotnet test

Configuration

Claude Desktop

Add the following to your Claude Desktop MCP configuration:

{
  "mcpServers": {
    "avalonia": {
      "command": "dotnet",
      "args": [
        "run",
        "--project",
        "/path/to/AvaloniaUI.MCP/src/AvaloniaUI.MCP/AvaloniaUI.MCP.csproj"
      ],
      "cwd": "/path/to/AvaloniaUI.MCP"
    }
  }
}

VS Code

Install the MCP extension and add to your settings:

{
  "mcp.servers": [
    {
      "name": "AvaloniaUI",
      "command": "dotnet",
      "args": [
        "run",
        "--project",
        "/path/to/AvaloniaUI.MCP/src/AvaloniaUI.MCP/AvaloniaUI.MCP.csproj"
      ],
      "cwd": "/path/to/AvaloniaUI.MCP"
    }
  ]
}

First Steps

1. Create Your First Project

Ask your MCP client: "Create a new AvaloniaUI MVVM project called MyApp"

This will generate a complete AvaloniaUI project with:

• MVVM architecture
• ReactiveUI integration
• Cross-platform support
• Best practices structure

2. Validate XAML

Ask: "Validate this XAML code: <Window>...</Window>"

The server will check for:

• Syntax errors
• Property validation
• Best practices compliance

3. Get Help with Migration

Ask: "How do I migrate this WPF control to AvaloniaUI?"

Get detailed migration guidance including:

• Control mappings
• Namespace changes
• Property updates

Environment Configuration

Log Levels

Set the log level using an environment variable:

export AVALONIA_MCP_LOG_LEVEL=Debug
dotnet run --project src/AvaloniaUI.MCP/AvaloniaUI.MCP.csproj

Available levels: Trace, Debug, Information, Warning, Error, Critical

Performance Tuning

For production use, consider these environment settings:

# Optimize for production
export ENVIRONMENT=production
export AVALONIA_MCP_LOG_LEVEL=Information

# Enable garbage collection optimization
export DOTNET_gcServer=1
export DOTNET_gcConcurrent=1

Troubleshooting

Common Issues

Server Not Starting

# Check .NET version
dotnet --version

# Ensure correct project path
dotnet run --project src/AvaloniaUI.MCP/AvaloniaUI.MCP.csproj --verbosity normal

Connection Issues

# Test server manually
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0.0"}}}' | dotnet run --project src/AvaloniaUI.MCP/AvaloniaUI.MCP.csproj

Performance Issues

# Check health status
# Use the diagnostic tool in your MCP client

Logging and Diagnostics

Enable detailed logging for troubleshooting:

export AVALONIA_MCP_LOG_LEVEL=Trace
dotnet run --project src/AvaloniaUI.MCP/AvaloniaUI.MCP.csproj 2>&1 | tee avalonia-mcp.log

Getting Help

• Check the troubleshooting guide
• Review common examples
• Open an issue on GitHub

Next Steps

• Explore the Tools Reference for complete functionality
• Check out Examples for common use cases
• Read the Tools Reference for advanced usage
• Join the community discussions