Skip to content

Quick Start

Get the F5XC API MCP Server running in 5 minutes.

Prerequisites

  • Node.js 24+ (for npx) OR Docker
  • An MCP-compatible AI assistant (Claude Desktop, Claude Code, VS Code, etc.)

Step 1: Choose Your Installation

No installation required. The server runs directly via npx.

npx @robinmordasiewicz/f5xc-api-mcp

Pull and run the container:

docker run -it ghcr.io/robinmordasiewicz/f5xc-api-mcp

Install globally for repeated use:

npm install -g @robinmordasiewicz/f5xc-api-mcp
f5xc-api-mcp

Step 2: Configure Your AI Assistant

Claude Desktop

Add to your Claude Desktop config file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "f5xc-api": {
      "command": "npx",
      "args": ["@robinmordasiewicz/f5xc-api-mcp"]
    }
  }
}

Claude Code

Add to your project's .mcp.json:

{
  "mcpServers": {
    "f5xc-api": {
      "command": "npx",
      "args": ["@robinmordasiewicz/f5xc-api-mcp"]
    }
  }
}

Step 3: Verify Installation

Restart your AI assistant and ask:

"What F5XC tools are available?"

You should see a response listing the available tools, resources, and prompts.

Step 4: (Optional) Enable API Execution

To execute API calls directly (not just documentation), set credentials:

{
  "mcpServers": {
    "f5xc-api": {
      "command": "npx",
      "args": ["@robinmordasiewicz/f5xc-api-mcp"],
      "env": {
        "F5XC_API_URL": "https://your-tenant.console.ves.volterra.io",
        "F5XC_API_TOKEN": "your-api-token"
      }
    }
  }
}

{
  "mcpServers": {
    "f5xc-api": {
      "command": "npx",
      "args": ["@robinmordasiewicz/f5xc-api-mcp"],
      "env": {
        "F5XC_API_URL": "https://your-tenant.console.ves.volterra.io",
        "F5XC_P12_BUNDLE": "/path/to/certificate.p12",
        "F5XC_P12_PASSWORD": "your-password"
      }
    }
  }
}

Try It Out

Once configured, try these example prompts:

Documentation Mode (No Auth)

"Show me how to create an HTTP load balancer in F5XC"

"What are the CURL commands to list namespaces?"

"What parameters are needed for an origin pool?"

Execution Mode (With Auth)

"List all HTTP load balancers in the 'production' namespace"

"Create an origin pool pointing to 10.0.0.1:8080"

"Get the status of the 'example-app' load balancer"

Next Steps