Skip to content

Installation

Multiple ways to install and run the F5XC API MCP Server.

System Requirements

  • Node.js: 24.0 or higher (for npm/npx installation)
  • Docker: 20.10 or higher (for container installation)
  • Operating System: macOS, Linux, or Windows

Installation Methods

MCPB Bundle (Claude Desktop - Easiest)

The simplest way to install for Claude Desktop users. No terminal required.

  1. Download the latest .mcpb file from GitHub Releases
  2. Double-click the file or drag it into Claude Desktop
  3. Click Install
  4. Configure your F5XC credentials when prompted (optional - runs in documentation mode without)

That's it! The extension is now available in Claude Desktop.

Drag and Drop Installation

You can also drag the .mcpb file directly into the Claude Desktop window to install it.

The easiest way to run the server from command line. No installation required.

npx @robinmordasiewicz/f5xc-api-mcp

This downloads and runs the latest version automatically.

npm Global Install

Install globally for faster startup on repeated use:

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

Then run:

f5xc-api-mcp

Docker

Pull from GitHub Container Registry:

docker pull ghcr.io/robinmordasiewicz/f5xc-api-mcp:latest

Or from Docker Hub:

docker pull robinmordasiewicz/f5xc-api-mcp:latest

Run the container:

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

With environment variables:

docker run -it \
  -e F5XC_API_URL=https://your-tenant.console.ves.volterra.io \
  -e F5XC_API_TOKEN=your-token \
  ghcr.io/robinmordasiewicz/f5xc-api-mcp

From Source

Clone and build from source:

git clone https://github.com/robinmordasiewicz/f5xc-api-mcp.git
cd f5xc-api-mcp
npm install
npm run build
npm start

Version Selection

Latest Stable

npx @robinmordasiewicz/f5xc-api-mcp@latest

Specific Version

npx @robinmordasiewicz/f5xc-api-mcp@1.0.0

Docker Tags

Tag Description
latest Latest stable release
1.0.0 Specific version
1.0 Latest patch of minor version
1 Latest minor of major version

Verifying Installation

Run the server and check the output:

npx @robinmordasiewicz/f5xc-api-mcp --version

Or test with a simple MCP connection:

echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"capabilities":{}}}' | npx @robinmordasiewicz/f5xc-api-mcp

Troubleshooting

Node.js Version Issues

Check your Node.js version:

node --version

If below 24.0, upgrade using:

brew install node@24
nvm install 24
nvm use 24

Download from nodejs.org

Permission Issues

If you get permission errors with global install:

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

Or use a Node version manager like nvm.

Docker Issues

If the container won't start, check Docker is running:

docker info

For permission issues on Linux:

sudo usermod -aG docker $USER

Then log out and back in.

Next Steps