Vyazen MCP — Quick Setup Guide

A concise, copy-ready step-by-step guide to get Vyazen (MCP server) running in your coding environment so your team can use AI-powered codebase search right inside your editor.

What Vyazen gives you

AI-powered code understanding

Intent-level natural language queries (not just keyword match).

Two search modes

search_simple (NL intent) and search_symbol (precise symbol/file lookup).

Editor integration

Use directly from Visual Studio Code, Cursor, Windsurf, and more for fast navigation.

Enterprise scale & security

Secure API keys, GitHub authorization, and filters for large repos.

Prerequisites

  • A Vyazen account (access to the Vyazen dashboard)
  • A GitHub account with permission to authorize Vyazen and add repositories
  • Your preferred code editor installed (VS Code, Cursor, Windsurf, etc.)
  • Access to at least one repository you want Vyazen to index
  • A secrets manager or secure place to store API keys (recommended for production)

Quick steps (at a glance)

  1. 1
    Log in to the Vyazen platform and authorize GitHub
  2. 2
    Add the repository you want Vyazen to index
  3. 3
    Generate an API key from the dashboard and copy it (displayed only once)
  4. 4
    Create MCP configuration in your editor and add the Vyazen server config with the API key
  5. 5
    Start your MCP server / enable the Vyazen MCP integration in your editor
  6. 6
    Disable built-in search tools (so Vyazen becomes the default) and start searching!

Step-by-step setup

Follow these detailed instructions to get Vyazen MCP up and running

01

Log in to Vyazen

Open the Vyazen platform and click Continue with GitHub to authorize the requested scopes so Vyazen can access selected repositories.
Note: Your organization will provide the dashboard URL.
02

Authorize GitHub integration

Grant Vyazen the permissions it requests (access to repos, PR management, etc.). Vyazen does not ask for your GitHub password — the authorization uses OAuth.
03

Add your repository

After authorization, you'll land on the Vyazen dashboard. Click + Add Repository, select the repo(s) you want Vyazen to index, and confirm.
04

Create an API key

In the dashboard navigation, open API Keys and click + Generate API Key. When the key appears, copy it immediately — it will only be shown once.
vk_key_74Viwjt8o6P7RhVz...

Treat API keys like credentials — never commit them into source control or paste them into public pages.

05

Add editor configuration

Configure your editor to connect to Vyazen MCP server. Select your editor below and follow the configuration format.

{
  "servers": {
    "vyazen": {
      "type": "http",
      "url": "https://mcp.vyazen.dev",
      "headers": {
        "Authorization": "Bearer <your_api_key_here>"
      }
    }
  }
}
{
  "mcpServers": {
    "vyazen": {
      "type": "http",
      "url": "https://mcp.vyazen.dev",
      "headers": {
        "Authorization": "Bearer <your_api_key_here>"
      }
    }
  }
}
{
  "mcpServers": {
    "vyazen": {
      "type": "http",
      "url": "https://mcp.vyazen.dev",
      "headers": {
        "Authorization": "Bearer <your_api_key_here>"
      }
    }
  }
}
{
  "mcpServers": {
    "vyazen": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-http"],
      "env": {
        "MCP_SERVER_URL": "https://mcp.vyazen.dev",
        "MCP_SERVER_HEADERS": "{\"Authorization\":\"Bearer <your_api_key_here>\"}"
      }
    }
  }
}
{
  "mcpServers": {
    "vyazen": {
      "type": "http",
      "url": "https://mcp.vyazen.dev",
      "headers": {
        "Authorization": "Bearer <your_api_key_here>"
      }
    }
  }
}

Configuration file paths:

  • VS Code:.vscode/mcp.json
  • Cursor:.cursor/mcp.json
  • Windsurf:.windsurf/mcp.json
  • Claude Desktop:~/Library/Application Support/Claude/claude_desktop_config.json
  • Cline:.cline/mcp.json

Replace <your_api_key_here> with the API key you generated in Step 04. Never commit API keys to source control.

06

Start the MCP server / integration

Save your configuration file. Start or enable the MCP server component used by your environment so the editor can communicate with the Vyazen MCP endpoint.
Note: How you start the MCP server depends on your setup: it may be started by an editor extension, a local process/CLI provided by your organization, or a Docker container.
07

Disable built-in tools so Vyazen takes priority

In your editor settings (or the Copilot configuration, if applicable), uncheck or disable any 'Built-in tools' option that would conflict with Vyazen search. This ensures Vyazen's search tools become the default search behavior.
08

Start using Vyazen

Vyazen currently supports TypeScript, JavaScript, and Python. Begin making queries from your editor using natural language or symbol lookups.

Best practices & tips

Keep API keys secure

Keep API keys out of source control — prefer environment variables or a secrets manager.

Use search_simple as default

Use search_simple as your default; reserve search_symbol for exact matches.

Scope searches for large repos

When indexing very large repos, scope searches with filePathContains or kind to speed up results.

Test with staging first

If you're testing, use the staging URL provided by Vyazen — switch to production URLs when promoting to prod.

Troubleshooting

Common issues and their solutions

If you still face issues, contact your Vyazen admin or reach out to our support team.