ACP VS Code Extension

Reference + How-To

Document Type: Reference + How-To
Status: OUTLINE — Content to be added
Last Updated: December 2025


Overview

The ACP VS Code extension provides IDE integration for the AI Context Protocol, including:

  • Real-time annotation highlighting
  • Constraint visualization
  • IntelliSense for ACP annotations
  • Cache status indicators
  • Quick fixes and code actions

Installation

TODO: Expand with screenshots and verification steps

From Marketplace

  1. Open VS Code
  2. Go to Extensions (Ctrl+Shift+X)
  3. Search for "ACP Protocol"
  4. Click Install

From VSIX

code --install-extension acp-vscode-0.1.0.vsix

From Source

git clone https://github.com/acp-protocol/acp-vscode
cd acp-vscode
npm install
npm run package
code --install-extension acp-vscode-*.vsix

Features

Annotation Highlighting

TODO: Add screenshots, configuration options

The extension highlights ACP annotations with distinct colors:

Annotation TypeColorExample
@acp:lock frozen🔴 RedCritical code
@acp:lock restricted🟡 YellowApproval needed
@acp:domain🔵 BlueDomain markers
@acp:fn, @acp:class🟢 GreenDocumentation

Constraint Gutter Icons

TODO: Add icon examples, click behaviors

Files with constraints show gutter icons:

  • 🔒 Frozen files
  • ⚠️ Restricted files
  • 📋 Approval required

IntelliSense

TODO: Add GIF showing autocomplete

The extension provides autocomplete for:

  • Annotation types (@acp:)
  • Lock levels (frozen, restricted, etc.)
  • Domain names from cache
  • Symbol references

Code Actions

TODO: Document all code actions

Available quick fixes:

  • "Add missing @acp:fn annotation"
  • "Convert comment to ACP annotation"
  • "Generate domain from file path"

Status Bar

TODO: Add screenshot, click actions

The status bar shows:

  • Cache status (fresh/stale)
  • File constraint level
  • Quick actions menu

Configuration

Extension Settings

{
  "acp.enabled": true,
  "acp.autoIndex": true,
  "acp.highlightAnnotations": true,
  "acp.showGutterIcons": true,
  "acp.showStatusBar": true,
  "acp.cacheWatchMode": "auto"
}

Settings Reference

SettingTypeDefaultDescription
acp.enabledbooleantrueEnable extension
acp.autoIndexbooleantrueAuto-reindex on save
acp.highlightAnnotationsbooleantrueHighlight annotations
acp.showGutterIconsbooleantrueShow constraint icons
acp.showStatusBarbooleantrueShow status bar item
acp.cacheWatchModestring"auto""auto", "manual", "daemon"

TODO: Add all settings with detailed descriptions


Commands

TODO: Document all commands with keybindings

CommandKeybindingDescription
ACP: Index ProjectCtrl+Shift+A IRegenerate cache
ACP: Show ConstraintsCtrl+Shift+A CShow file constraints
ACP: Go to DomainCtrl+Shift+A DJump to domain file
ACP: Add AnnotationCtrl+Shift+A AInsert annotation

LSP Integration

TODO: Document LSP features

The extension uses a Language Server Protocol (LSP) server for:

  • Diagnostics
  • Hover information
  • Go to definition (for variables)
  • Find references

LSP Configuration

{
  "acp.lsp.enabled": true,
  "acp.lsp.path": "acp-lsp",
  "acp.lsp.trace": "off"
}

Troubleshooting

TODO: Expand with common issues

Extension Not Activating

  1. Check that .acp.config.json exists
  2. Verify the extension is enabled
  3. Check Output panel for errors

Highlighting Not Working

  1. Verify language is supported
  2. Check acp.highlightAnnotations setting
  3. Restart VS Code

Cache Not Updating

  1. Check acp.autoIndex setting
  2. Run ACP: Index Project manually
  3. Check for indexing errors in Output

Sections to Add

  • Keyboard Shortcuts: Complete keybinding reference
  • Themes: Customizing annotation colors
  • Multi-root Workspaces: Handling multiple projects
  • Remote Development: WSL, SSH, Containers
  • Performance: Large codebase optimization
  • Debugging: Enabling extension debug logging

This document is an outline. Contribute content →