Welcome to the Zed integration guide. This guide will help you connect ByteRover with Zed editor, providing persistent memory capabilities to enhance your AI-powered development experience.

What You’ll Need

  • Zed editor installed
  • A ByteRover account

Getting Started

1. Start the Connection

Go to your ByteRover dashboard and:
  1. Find the “Connect your agent” section
  2. Click on Zed from the list
  3. Hit the “Connect with Zed” button

2. Connect ByteRover to Zed

Step 1: Install Byterover Extension Click below button to install Byterover Extension. Install Byterover in Zed Step 2: Update project settings Open or create Zed project settings file at <project-root>/.zed/settings.json, and add the following configuration:
{
  "context_servers": {
    "mcp-server-byterover": {
      "settings": {
        "source": "extension",
        "memory_workspace_key": "[DASHBOARD_TOKEN]",
        "user_email": "[YOUR_EMAIL]"
      }
    }
  }
}
Save the setting, and open agent configuration via Command/Control + Shift + P and type agent: open configuration. You should see the ByteRover MCP Server under Model Context Protocol (MCP) Servers section.

Test the Connection

Try this with Zed’s AI assistant:
Store this string manipulation utility to ByteRover:

function capitalizeWords(str) {
  if (!str || typeof str !== 'string') {
    return '';
  }
  
  return str
    .toLowerCase()
    .split(' ')
    .map(word => word.charAt(0).toUpperCase() + word.slice(1))
    .join(' ');
}
Zed’s AI should confirm the pattern was stored successfully.

Features

ByteRover provides Zed’s AI with persistent memory of your coding patterns, project context, and solutions. This means more relevant suggestions and less repetitive explanations.
Yes. With access to your coding history through ByteRover, Zed’s AI becomes more contextually aware and provides better assistance tailored to your style.
Absolutely. Your stored knowledge is available across all projects and Zed sessions, building a comprehensive personal coding knowledge base.
With ByteRover team plans, your development team can share collective knowledge, making everyone’s Zed AI assistant more effective.

Troubleshooting

Ensure you’ve installed the ByteRover extension correctly. Check that the extension appears in Zed’s extension list. Try restarting Zed after installation.
Verify your .zed/settings.json file syntax is correct (valid JSON). Double-check that your ByteRover credentials are accurate. Make sure there are no trailing commas in the JSON.
Confirm your ByteRover account is active and has available operations. Check that the context server shows as connected in Zed. Test with a simple storage command first.
Memory operations are designed to be lightweight and shouldn’t impact Zed’s performance. If you notice issues, check your network connection or temporarily disable the integration.

Best Practices

Be specific about what you’re storing:
"Store this Rust error handling pattern for file operations"
"Save this JavaScript async/await pattern for API calls"
Use consistent naming and categorization:
"Store this Python decorator for timing functions"
"Save this CSS animation for smooth transitions"
Search with specific terms:
"Find my stored authentication patterns"
"Retrieve state management examples"

What’s Next?

Continue using Zed for your development work, now enhanced with ByteRover’s memory capabilities. Store valuable code patterns and solutions as you build. Your AI assistant will become increasingly knowledgeable about your coding preferences and project requirements.
Need help? Our Discord community has Zed users who can assist with setup and best practices.