Get the FREE Ultimate OpenClaw Setup Guide →

lsp-enable

npx machina-cli add skill zircote/lsp-tools/lsp-enable --openclaw
Files (1)
SKILL.md
9.7 KB

LSP-First Code Intelligence

The Iron Laws

1. NO MODIFYING UNFAMILIAR CODE WITHOUT goToDefinition FIRST
2. NO REFACTORING WITHOUT findReferences IMPACT ANALYSIS FIRST
3. NO CLAIMING CODE WORKS WITHOUT LSP DIAGNOSTICS VERIFICATION

Violating these laws wastes tokens, introduces bugs, and produces incomplete changes.

Trigger Phrases

Activate when user says:

  • "find definition", "go to definition", "where is X defined"
  • "find references", "who uses this", "what calls this function"
  • "understand this code", "trace this function", "explore codebase"
  • "before I refactor", "impact of changing", "safe to rename"
  • "analyze dependencies", "call hierarchy", "incoming calls"
  • "check this code", "verify implementation", "LSP diagnostics"

Core Decision Tree

WHAT DO YOU NEED?
│
├─ Symbol definition or implementation
│  └─ USE LSP: goToDefinition, goToImplementation
│
├─ All usages of a symbol
│  └─ USE LSP: findReferences
│
├─ Type info, docs, or signatures
│  └─ USE LSP: hover
│
├─ File structure or symbol list
│  └─ USE LSP: documentSymbol
│
├─ Call graph or dependencies
│  └─ USE LSP: incomingCalls, outgoingCalls
│
├─ Symbol search across workspace
│  └─ USE LSP: workspaceSymbol
│
├─ Literal text search (TODOs, strings, config)
│  └─ USE: Grep (LSP doesn't do text matching)
│
└─ File discovery by pattern
   └─ USE: Glob

The Nine LSP Operations

OperationPurposeUse Before
goToDefinitionJump to where symbol is definedModifying unfamiliar code
findReferencesFind all usages of a symbolRefactoring, renaming
goToImplementationFind interface implementationsWorking with polymorphism
hoverGet type info, docs, signaturesUnderstanding APIs
documentSymbolList all symbols in a fileUnderstanding large files
workspaceSymbolSearch symbols across codebaseFinding related code
prepareCallHierarchyGet call hierarchy infoAnalyzing call graphs
incomingCallsFind callers of a functionImpact analysis
outgoingCallsFind functions called by targetDependency tracing

Required parameters for all operations:

  • filePath - Absolute path to file
  • line - Line number (1-based)
  • character - Column position (1-based)

Full operation guide: references/lsp-operations-guide.md

Pre-Edit Protocol (Mandatory)

Before modifying ANY unfamiliar code:

1. NAVIGATE: LSP goToDefinition → understand implementation
2. ANALYZE: LSP findReferences → assess change impact
3. INSPECT: LSP hover → verify type signatures
4. THEN: Make changes

Pre-Edit Checklist:

  • Used goToDefinition to understand implementation
  • Used findReferences to identify all usages
  • Reviewed type signatures via hover
  • Understand interface/trait contracts
  • Know what breaks if this changes

Skip any step = incomplete understanding = bugs

Post-Edit Verification (Mandatory)

After code changes:

1. CHECK: LSP diagnostics for errors/warnings
2. VERIFY: No new type errors introduced
3. CONFIRM: Imports resolve correctly
4. VALIDATE: Interface contracts still satisfied

Do NOT claim code works without LSP diagnostics verification.

LSP Availability Check

Before LSP operations, verify setup:

# Environment variable must be set
echo $ENABLE_LSP_TOOL  # Should output "1"

# If not set, add to shell profile:
export ENABLE_LSP_TOOL=1

If LSP unavailable:

  1. Warn user: "LSP not available. Semantic operations will be less accurate."
  2. Suggest fix: "Set ENABLE_LSP_TOOL=1 in your shell profile"
  3. Fall back: Use Grep/Read with documented limitation
  4. Note limitation: "Used grep fallback - may include false positives"

Full setup guide: references/lsp-setup-verification.md

Server Installation

If LSP servers are not installed, use /lsp-tools:lsp-setup for guided installation.

Quick verification:

# Run verification script
bash "${CLAUDE_PLUGIN_DIR}/scripts/bash/verify-lsp-servers.sh"

Per-language installation scripts are available:

LanguageServerInstall Script
TypeScript/JSvtslsscripts/bash/install-typescript-lsp.sh
Pythonpyrightscripts/bash/install-python-lsp.sh
Rustrust-analyzerscripts/bash/install-rust-lsp.sh
Gogoplsscripts/bash/install-go-lsp.sh
Javajdtlsscripts/bash/install-java-lsp.sh
Kotlinkotlin-language-serverscripts/bash/install-kotlin-lsp.sh
C/C++clangdscripts/bash/install-cpp-lsp.sh
C#OmniSharpscripts/bash/install-csharp-lsp.sh
PHPphpactorscripts/bash/install-php-lsp.sh
Rubyruby-lspscripts/bash/install-ruby-lsp.sh
HTML/CSSvscode-langserversscripts/bash/install-html-css-lsp.sh
LaTeXtexlabscripts/bash/install-latex-lsp.sh

Windows users: Use corresponding PowerShell scripts in scripts/powershell/.

Server registry with full details: references/lsp-server-registry.md

Why LSP Over Grep

MetricLSPGrep
Speed (large codebase)~50ms45+ seconds
AccuracyExact semantic matchesText patterns (false positives)
Token usage~500 tokens (worth it)Burns tokens on irrelevant matches
Type resolutionFollows aliases, re-exportsText only
Scope awarenessUnderstands variable scopeMatches all text

Example:

Grep "getUserById" → 500+ matches (comments, strings, similar names)
LSP findReferences → 23 matches (exact function usages only)

Red Flags - STOP and Use LSP

If you catch yourself:

  • "I'll just grep for the function name"
  • "Quick refactor, don't need to check references"
  • "Code looks fine, probably works"
  • "I know what this function does" (without reading it)
  • Proposing changes to unfamiliar code without navigation
  • Claiming refactor is complete without impact analysis

ALL of these mean: STOP. Use LSP first.

Token Optimization Awareness

LSP is more expensive per-call but cheaper overall:

ScenarioGrep CostLSP Cost
Find method usages in 100-file project2000+ tokens (scanning output)500 tokens (exact matches)
Navigate to definitionMultiple grep attemptsSingle LSP call
Understand type signaturesRead multiple filesSingle hover call

Rule: When codebase > 20 files, LSP saves tokens vs grep.

Language-Specific Guidance

Use language-specific LSP sections for tooling and quality gates:

LanguageReference File
TypeScript/JavaScriptreferences/typescript-lsp-section.md
Pythonreferences/python-lsp-section.md
Goreferences/go-lsp-section.md
Rustreferences/rust-lsp-section.md
Javareferences/java-lsp-section.md
Kotlinreferences/kotlin-lsp-section.md
C/C++references/cpp-lsp-section.md
C#references/csharp-lsp-section.md
PHPreferences/php-lsp-section.md
Rubyreferences/ruby-lsp-section.md
HTML/CSSreferences/html-css-lsp-section.md
LaTeXreferences/latex-lsp-section.md

Each file includes:

  • Navigation and verification workflows
  • Pre-edit checklists
  • Language-specific quality gates
  • Hooks for automated formatting/linting

Enforcement Protocol Summary

Reference: references/lsp-enforcement-protocol.md

  1. Pre-Edit: LSP navigation is MANDATORY before modifying unfamiliar code
  2. Pre-Refactor: findReferences impact analysis is MANDATORY
  3. Post-Edit: LSP diagnostics check is MANDATORY before claiming success
  4. Fallback: When LSP unavailable, warn → suggest fix → document limitation
  5. Token awareness: Prefer LSP over grep for semantic operations

Quick Reference

Before modifying code:

LSP goToDefinition → Understand implementation
LSP findReferences → Know what breaks
LSP hover → Verify types

After modifying code:

LSP diagnostics → Check for errors
Build/typecheck → Verify compilation
Tests → Confirm behavior

Decision matrix: references/lsp-decision-matrix.md

Source

git clone https://github.com/zircote/lsp-tools/blob/main/skills/lsp-enable/SKILL.mdView on GitHub

Overview

lsp-enable provides IDE-like code intelligence backed by LSP operations. It enforces mandatory pre-edit checks, impact analysis before refactoring, and post-edit diagnostics to ensure safe changes in large codebases. It supports navigation (goToDefinition, findReferences), understanding (hover, documentSymbol), and call analysis (incomingCalls, outgoingCalls).

How This Skill Works

Operates by guiding you through LSP-based actions before edits. Start with navigation to understand implementation, use references to assess impact, and verify signatures with hover and documentSymbol. After making changes, run LSP diagnostics and confirm imports and interface contracts remain valid.

When to Use It

  • Find the definition of a symbol to understand its implementation.
  • Find all usages of a symbol to assess refactor impact.
  • Understand code by inspecting type information and docs (hover).
  • Plan a refactor with impact analysis and safety checks before changes.
  • Analyze dependencies and call hierarchy (incoming/outgoingCalls) across the codebase.

Quick Start

  1. Step 1: Use goToDefinition to understand implementation.
  2. Step 2: Use findReferences to assess change impact.
  3. Step 3: After changes, run LSP diagnostics and verify imports.

Best Practices

  • Always start with goToDefinition to understand implementation.
  • Use findReferences before refactoring to assess change impact.
  • Verify type signatures and docs via hover before edits.
  • Use documentSymbol to get an overview of large files.
  • Run LSP diagnostics after edits and ensure imports and interfaces are intact.

Example Use Cases

  • Navigating a legacy module to locate a function’s definition.
  • Assessing all usages of a symbol before renaming.
  • Tracing a call graph to understand dependencies during refactoring.
  • Reviewing type signatures and docs when onboarding to a new API.
  • Verifying post-edit diagnostics to ensure compilation and imports are correct.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers