Installation

Get OmniMCP up and running in your project in minutes.

Prerequisites

• Node.js 16.0 or higher
• npm, yarn, or pnpm package manager

Package Installation

Install the main package

npm install omnimcp

Or if you prefer to install individual packages:

# Core functionality
npm install @omnimcp/client @omnimcp/core

# Optional: CLI tools
npm install -g @omnimcp/cli

# Optional: Web UI
npm install @omnimcp/web

Environment Setup

If you plan to use AI features, create a .env file in your project root:

# For OpenAI integration
OPENAI_API_KEY=your-api-key-here

# For Anthropic integration  
ANTHROPIC_API_KEY=your-api-key-here

TypeScript Configuration

OmniMCP is written in TypeScript and provides full type definitions. If you`re using TypeScript, ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "moduleResolution": "node",
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

Verify Installation

Test your installation by creating a simple script:

import { MCPClient } from '@omnimcp/client';

const client = new MCPClient('test-app', '1.0.0');
console.log('OmniMCP installed successfully!');
console.log('Client info:', client.clientInfo);

Run the script:

node test.js

Using the CLI

If you installed the CLI globally, verify it`s working:

omnimcp --version
omnimcp --help

Next Steps

Now that you have OmniMCP installed, head over to our Quick Start guide to create your first MCP connection.