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

# Installation

> Install CodeArchitect MCP and configure it for your coding agent

## Prerequisites

* Node.js v18+ and npm
* An IDE with MCP support

## Install

```bash theme={null}
npm install -g codearchitect-mcp
```

## Configuration by Coding Agent

<Tabs>
  <Tab title="Cursor">
    ### Method 1: Using Cursor Settings UI

    1. Open Cursor (the code editor)
    2. Click the gear icon ⚙️ in the bottom left corner (or press `Ctrl+,` on Windows/Linux, `Cmd+,` on Mac)
    3. In Settings search box, type: "MCP" or "Model Context Protocol"
    4. Click on "Tools & MCP" section
    5. Click "Add Server" or the + button
    6. Fill in the form:
       * **Name**: `codearchitect`
       * **Command**: `npx`
       * **Args**: `-y codearchitect-mcp@latest`
    7. Click Save or OK

    ### Method 2: Manual Config File

    1. Close Cursor
    2. Navigate to your home folder:
       * **Windows**: `C:\Users\YourName\.cursor\` (create `.cursor` folder if needed)
       * **Mac/Linux**: `~/.cursor/` (create `.cursor` folder if needed)
    3. Create a file named `mcp.json` in that folder
    4. Open it in a text editor and paste:

    ```json theme={null}
    {
      "mcpServers": {
        "codearchitect": {
          "command": "npx",
          "args": ["-y", "codearchitect-mcp@latest"]
        }
      }
    }
    ```

    5. Save the file and open Cursor again

    ### Verify Setup

    1. Check the bottom status bar - you should see "MCP" or "codearchitect" with a green dot (connected)
    2. Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac)
    3. Type "Reload Window" and press Enter
    4. Open any chat/conversation in Cursor
    5. Type: `use codearchitect`
    6. You should see a list of features and workflow guide

    ### Export Chat

    To save conversations:

    1. In Cursor chat, click the three dots menu (⋯) in the top right corner
    2. Click "Export Chat"
    3. Navigate to: `C:\Users\YourName\.codearchitect\exports\` (Windows) or `~/.codearchitect/exports/` (Mac/Linux)
       * Create the `exports` folder if it doesn't exist
    4. Click Save (file will be saved as `.md` format)
  </Tab>

  <Tab title="VS Code">
    ### Setup Steps

    1. Open VS Code (Visual Studio Code)
    2. Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac) to open Command Palette
    3. Type "MCP: Add Server" and select it
    4. Choose "Download with npm package"
    5. Enter package name: `codearchitect-mcp`
    6. Press Enter and wait for installation

    ### Verify Setup

    1. Check the bottom right corner - you should see "MCP" or "codearchitect" with a green indicator
    2. Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac)
    3. Type "Developer: Reload Window" and press Enter
    4. Open any chat/conversation in VS Code
    5. Type: `use codearchitect`
    6. You should see a list of features and workflow guide

    ### Export Chat

    To save conversations:

    1. In VS Code chat, press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac)
    2. Type "Export Chat" and select it
    3. Name your file meaningfully (e.g., `auth-implementation.json`, `database-design.json`)
    4. Navigate to: `C:\Users\YourName\.codearchitect\exports\` (Windows) or `~/.codearchitect/exports/` (Mac/Linux)
       * Create the `exports` folder if it doesn't exist
    5. Click Save (file will be saved as `.json` format - CodeArchitect supports this!)
  </Tab>

  <Tab title="Claude Desktop">
    1. Open the configuration file:
       * **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
       * **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

    2. Add CodeArchitect configuration:

    ```json theme={null}
    {
      "mcpServers": {
        "codearchitect": {
          "command": "npx",
          "args": ["-y", "codearchitect-mcp@latest"]
        }
      }
    }
    ```

    3. Restart Claude Desktop
  </Tab>

  <Tab title="Windsurf">
    1. Go to **Settings → MCP Servers**

    2. Add CodeArchitect configuration:
       * **Name**: `codearchitect`
       * **Command**: `npx`
       * **Args**: `-y codearchitect-mcp@latest`

    3. Save and restart Windsurf
  </Tab>

  <Tab title="Continue.dev">
    1. Go to **Settings → MCP Servers**

    2. Add CodeArchitect configuration:

    ```json theme={null}
    {
      "mcpServers": {
        "codearchitect": {
          "command": "npx",
          "args": ["-y", "codearchitect-mcp@latest"]
        }
      }
    }
    ```

    3. Reload Continue
  </Tab>

  <Tab title="Cline">
    1. Go to **Configuration → MCP Settings**

    2. Add CodeArchitect configuration:
       * **Server ID**: `codearchitect`
       * **Command**: `npx`
       * **Args**: `-y codearchitect-mcp@latest`

    3. Restart Cline
  </Tab>
</Tabs>

## Verify

After configuration, test CodeArchitect MCP by asking your AI assistant:

```bash theme={null}
use codearchitect
```

This should show you all available features. Check that `codearchitect_help`, `store_session`, and `get_session` appear in your IDE's available tools list. See [Troubleshooting](/troubleshooting) if issues occur.
