Installation
Multiple ways to install and configure ekkOS for your environment.
Prerequisites
- Node.js 18+ — Required for the MCP server
- npm or yarn — Package manager
- ekkOS API Key — Get one at platform.ekkos.dev
Installation Methods
NPX (Recommended)
EasiestNo installation required. The MCP server runs directly via npx:
npx @ekkos/mcp-server
This is the method used in MCP configuration files. The package is downloaded and cached automatically.
Global Installation
Faster startupInstall globally for faster startup times:
npm install -g @ekkos/mcp-server
After global install, use ekkos-mcp as the command in your config.
TypeScript SDK
For custom integrationFor building custom integrations or using ekkOS in your own applications:
npm install @ekkos/sdk
The SDK provides typed access to all ekkOS APIs for Node.js applications.
Environment Variables
| Variable | Required | Description |
|---|---|---|
EKKOS_API_KEY | Yes | Your ekkOS API key from the dashboard |
EKKOS_API_URL | No | API endpoint (default: https://mcp.ekkos.dev) |
EKKOS_DEBUG | No | Enable debug logging (set to "true") |
Verify Installation
Test that the MCP server starts correctly:
EKKOS_API_KEY=your_key npx @ekkos/mcp-server
You should see output indicating the server is ready to accept MCP connections.
The MCP server is designed to be started by your AI tool (Claude Code, Cursor), not run standalone. This test just verifies the installation works.