DocsQuickstart

Get Started with Byterover

This quickstart walks you through setting up your organization, configuring your project, selecting the LLM backend, and integrating Memories Memories into your Vibe coder. Start by storing your coding agent’s first memory and begin your journey today! 🚀

Set Up Your Organization

If you’re an owner, follow these steps. (Non-owners can skip this section).

  1. Sign up for a Byterover account.
  2. Create a new organization in your account.

Create a Project

Store all your Memories by creating a new project: • Go to the Projects section in the Byterover interface and create a new project.

Install and Set Up the Byterover MCP Server

NPM Installation

  1. System Requirements

    • Node.js version 20 or higher
    • npm (comes with Node.js)

  2. Install the Byterover MCP Server

    npm i byterover-mcp

  3. Configure the MCP Server Create or update your configuration file based on your operating system:

    For MacOS / Linux:

    {
  "mcpServers": {
    "Byterover Memory MCP": {
      "command": "npx",
      "args": [
        "-y",
        "byterover-mcp",
        "--byterover-public-api-key=YOUR_PUBLIC_KEY",
        "--user-id=YOUR-NAME",
        "--llm-key-name=YOUR-LLM-KEY-NAME",
        "--model=YOUR-LLM-MODEL-NAME",
        "--stdio"
      ]
    }
  }
}

    For Windows:

    {
  "mcpServers": {
    "Byterover Memory MCP": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "byterover-mcp",
        "--byterover-public-api-key=YOUR_PUBLIC_KEY",
        "--user-id=YOUR-NAME",
        "--llm-key-name=YOUR-LLM-KEY-NAME",
        "--model=YOUR-LLM-MODEL-NAME",
        "--stdio"
      ]
    }
  }
}

Supported Models

Byterover requires an LLM to work and supports integration with both OpenAI and Anthropic models. Here are the currently supported models:

OpenAI Models

  • gpt-4o - optimized for performance and cost
  • gpt-4o-mini - optimized for cost
  • o3-mini - optimized for performance and cost
  • o1 - optimized for performance
  • gpt-4.5-preview - Preview version of GPT-4.5

Anthropic Models

  • claude-3-7-sonnet-20250219 - latest and most optimized for coding performance
  • claude-3-5-sonnet-20241022 - optimized for performance and cost
  • claude-3-opus-20240229 - optimized for performance
  • claude-3-5-haiku-20241022 - optimized for performance and cost

Choose the appropriate model based on your needs when configuring the MCP server. For optimal performance, we recommend using either claude-3-5-sonnet-20241022, gpt-4o or o3-mini models.

Configuration Parameters

  • YOUR_PUBLIC_KEY: Your Byterover public API key
  • YOUR-NAME: Your unique identifier in the system
  • YOUR-LLM-KEY-NAME: Your Language Model API key name
  • YOUR-LLM-MODEL-NAME: The specific model you want to use (e.g., “gpt-4o-mini”)
✅

Done! You’ve successfully set up the Byterover MCP Server.

OverviewMemories