> ## Documentation Index
> Fetch the complete documentation index at: https://mcpkit.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install and configure MCPKit on your system

## System Requirements

Before installing MCPKit, ensure your system meets these requirements:

* **Node.js** 18.0.0 or later
* **npm** 9.0.0 or later (comes with Node.js)
* **Operating System**: macOS, Linux, or Windows

<Tip>
  Check your Node.js version with `node --version`
</Tip>

## Install with npm

The easiest way to install MCPKit is via npm:

```bash theme={null}
npm install -g @kevinoconnell/mcpkit
```

<Check>
  The `-g` flag installs MCPKit globally, making it available from anywhere in your terminal.
</Check>

### Verify Installation

Confirm MCPKit is installed correctly:

```bash theme={null}
mcpkit version
```

You should see the current version number printed to the console.

## Alternative Installation Methods

<Tabs>
  <Tab title="pnpm">
    ```bash theme={null}
    pnpm add -g @kevinoconnell/mcpkit
    ```
  </Tab>

  <Tab title="yarn">
    ```bash theme={null}
    yarn global add @kevinoconnell/mcpkit
    ```
  </Tab>

  <Tab title="From Source">
    Clone and build from the GitHub repository:

    ```bash theme={null}
    git clone https://github.com/kevoconnell/mcpkit.git
    cd mcpkit
    npm install
    npm run build
    npm link
    ```

    <Info>
      Building from source is useful for development or if you want to use the latest unreleased features.
    </Info>
  </Tab>
</Tabs>

## Initial Configuration

After installing MCPKit, you need to configure your API keys.

### Get Your API Keys

You'll need:

1. **Browserbase API Key and Project id**
   * Sign up at [browserbase.com](https://www.browserbase.com)
   * Navigate to your dashboard
   * Copy your API key and Project ID from the settings

2. **LLM API Key** (choose one):
   * **Google Gemini** (recommended): Get an API key from [Google AI Studio](https://aistudio.google.com/app/apikey)
   * **OpenAI**: Get an API key from [OpenAI Platform](https://platform.openai.com)
   * **Anthropic**: Get an API key from [Anthropic Console](https://console.anthropic.com)

### Configure Secrets

Run the setup wizard:

```bash theme={null}
mcpkit secrets
```

You'll be prompted to enter your credentials:

```
? Enter your Browserbase API key: bb_xxxxxxxxxxxxxxxx
? Select your LLM provider: Google Gemini
? Enter your Gemini API key: AIxxxxxxxxxxxxxxxxx
```

<Info>
  Your credentials are stored locally in `~/.mcpkit/secrets.json` and are never shared.
</Info>

### Verify Configuration

Check that your secrets are configured correctly:

```bash theme={null}
mcpkit secrets show
```

This will display your configured provider (without showing the full API keys).

## Updating MCPKit

To update to the latest version:

```bash theme={null}
npm update -g @kevinoconnell/mcpkit
```

Or reinstall:

```bash theme={null}
npm install -g @kevinoconnell/mcpkit@latest
```

<Tip>
  Check for updates regularly to get the latest features and bug fixes.
</Tip>

## Uninstalling

To remove MCPKit from your system:

```bash theme={null}
npm uninstall -g @kevinoconnell/mcpkit
```

Your configuration files in `~/.mcpkit/` will remain. To completely remove all MCPKit data:

<Tabs>
  <Tab title="macOS/Linux">
    ```bash theme={null}
    npm uninstall -g @kevinoconnell/mcpkit
    rm -rf ~/.mcpkit
    ```
  </Tab>

  <Tab title="Windows">
    ```powershell theme={null}
    npm uninstall -g @kevinoconnell/mcpkit
    Remove-Item -Recurse -Force "$env:USERPROFILE\.mcpkit"
    ```
  </Tab>
</Tabs>

## Troubleshooting Installation

<AccordionGroup>
  <Accordion title="Permission Denied Error" icon="lock">
    If you encounter permission errors on macOS/Linux, you have two options:

    **Option 1: Use a Node version manager (recommended)**

    ```bash theme={null}
    # Install nvm
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

    # Install Node.js
    nvm install 18
    nvm use 18

    # Now install mcpkit
    npm install -g @kevinoconnell/mcpkit
    ```

    **Option 2: Use sudo (not recommended)**

    ```bash theme={null}
    sudo npm install -g @kevinoconnell/mcpkit
    ```

    <Warning>
      Using sudo with npm can cause permission issues. We recommend using a Node version manager instead.
    </Warning>
  </Accordion>

  <Accordion title="Command Not Found" icon="terminal">
    If `mcpkit` command is not found after installation:

    1. **Check npm global bin path:**
       ```bash theme={null}
       npm config get prefix
       ```

    2. **Add npm bin to PATH:**

       macOS/Linux (add to `~/.bashrc` or `~/.zshrc`):

       ```bash theme={null}
       export PATH="$(npm config get prefix)/bin:$PATH"
       ```

       Windows: Add the npm global bin path to your system PATH environment variable.

    3. **Restart your terminal** and try again.
  </Accordion>

  <Accordion title="Node.js Version Too Old" icon="triangle-exclamation">
    MCPKit requires Node.js 18 or later. Update Node.js:

    **Using nvm (recommended):**

    ```bash theme={null}
    nvm install 18
    nvm use 18
    ```

    **Or download from:**
    [nodejs.org](https://nodejs.org)
  </Accordion>

  <Accordion title="Installation Hangs or Fails" icon="spinner">
    If installation hangs or fails:

    1. **Clear npm cache:**
       ```bash theme={null}
       npm cache clean --force
       ```

    2. **Use a different registry:**
       ```bash theme={null}
       npm install -g @kevinoconnell/mcpkit --registry=https://registry.npmjs.org/
       ```

    3. **Try with verbose logging:**
       ```bash theme={null}
       npm install -g @kevinoconnell/mcpkit --verbose
       ```
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Quickstart Guide" icon="rocket" href="/quickstart">
    Create your first MCP server in 5 minutes
  </Card>

  <Card title="CLI Commands" icon="terminal" href="/commands/create">
    Learn about all available commands
  </Card>
</CardGroup>