Mikk
Guides

VS Code Extension

The Mikk VS Code extension brings codebase intelligence directly into your editor — module tree, impact analysis, contract status, and MCP integration.

The extension reads from mikk.lock.json

All extension features are powered by the pre-computed lock file. Run mikk init or mikk watch first to generate it. The extension auto-refreshes when mikk.lock.json or mikk.json changes on disk.

Installation

Install from VS Code Marketplace

Search for "Mikk" in the Extensions panel, or install from the command line:

code --install-extension getmikk.mikk-vscode

Initialize Mikk in your project

cd my-project
mikk init

The extension activates automatically when it detects mikk.lock.json in the workspace root.

(Optional) Connect to GitHub Copilot

Register Mikk's MCP server with VS Code:

mikk mcp install --tool vscode

This adds Mikk's 41 tools to GitHub Copilot Chat so you can use @mikk directly.

Features

Module Tree

Sidebar view showing all detected modules, their file counts, function counts, and public API surfaces. Click any function to jump to definition.

Functions Explorer

Searchable list of all functions in the workspace with inline metadata — module, line range, exported status.

Health Dashboard

Contract violation count, sync status, and constraint results in a dedicated sidebar panel.

Smart Status Bar

Live sync state indicator in the status bar. Green = clean, yellow = drifted, red = violations. Click to run mikk analyze.

Impact Analysis

Right-click any file → 'Show Impact' to see the full blast radius before editing — classified by severity.

MCP Integration

Connects Mikk's 41 MCP tools directly to GitHub Copilot Chat via @mikk.

Commands

All commands available via the Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

Prop

Type

The extension adds three sidebar panels:

Module Tree (mikkModules)

📦 MIKK MODULES
  ├── auth (12 files, 3 public API)
  │   ├── login
  │   ├── logout
  │   └── validateToken
  ├── payments (8 files, 2 public API)
  │   ├── createCharge
  │   └── refund
  └── api (24 files)

Functions Explorer (mikkFunctions)

Searchable, filterable list of all tracked functions — click to jump to source.

Health Dashboard (mikkHealth)

⚡ ARCHITECTURE HEALTH
  ✅ auth — 0 violations
  ✅ payments — 0 violations
  ❌ api — 1 violation
     api/routes.ts imports db directly (Rule: no-call["db"])

  Sync: ✅ Clean (last: 2 minutes ago)

MCP Integration with Copilot

When mikk mcp install --tool vscode is run, Mikk's 41 tools are registered with GitHub Copilot Chat:

@mikk What breaks if I change src/auth/login.ts?
@mikk Build context for: "Add rate limiting to the API layer"
@mikk Is it safe to rename verifyToken to validateJwt?
@mikk Show me dead code in the auth module

This gives Copilot the same real architectural grounding as Claude Desktop — module boundaries, exact function locations, constraint rules, and pre-edit safety validation — directly in VS Code.

File Watcher Integration

The extension watches both mikk.lock.json and mikk.json for changes and automatically refreshes all views — no manual reload needed. This means:

  • Running mikk analyze from the terminal immediately updates all sidebar panels
  • Saving mikk.json (e.g. adding a constraint) immediately reflects in the Health view
  • The status bar indicator stays current without polling

Building from Source

git clone https://github.com/getmikk/mesh
cd packages/vscode-extension
bun install
bun run build

Then press F5 in VS Code to launch the extension in a development Extension Host window.

Was this page helpful?

On this page