Skip to content

017-docs-lsp.md

Latest commit

 

History

History
160 lines (112 loc) · 5.14 KB

017-docs-lsp.md

File metadata and controls

160 lines (112 loc) · 5.14 KB
Raw
title LSP Servers
url https://opencode.ai/docs/lsp
source sitemap
fetched_at 2026-04-17 06:33:21 -0300
rendered_js false
word_count 424
summary This document explains how OpenCode manages Language Server Protocol (LSP) integration, including built-in server support and user configuration options.
tags
lsp-integration
opencode-config
development-environment
language-server-protocol
category guide

OpenCode integrates with your LSP servers.

OpenCode integrates with your Language Server Protocol (LSP) to help the LLM interact with your codebase. It uses diagnostics to provide feedback to the LLM.

Built-in

OpenCode comes with several built-in LSP servers for popular languages:

LSP ServerExtensionsRequirementsastro.astroAuto-installs for Astro projectsbash.sh, .bash, .zsh, .kshAuto-installs bash-language-serverclangd.c, .cpp, .cc, .cxx, .c++, .h, .hpp, .hh, .hxx, .h++Auto-installs for C/C++ projectscsharp.cs.NET SDK installedclojure-lsp.clj, .cljs, .cljc, .ednclojure-lsp command availabledart.dartdart command availabledeno.ts, .tsx, .js, .jsx, .mjsdeno command available (auto-detects deno.json/deno.jsonc)elixir-ls.ex, .exselixir command availableeslint.ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vueeslint dependency in projectfsharp.fs, .fsi, .fsx, .fsscript.NET SDK installedgleam.gleamgleam command availablegopls.gogo command availablehls.hs, .lhshaskell-language-server-wrapper command availablejdtls.javaJava SDK (version 21+) installedjulials.jljulia and LanguageServer.jl installedkotlin-ls.kt, .ktsAuto-installs for Kotlin projectslua-ls.luaAuto-installs for Lua projectsnixd.nixnixd command availableocaml-lsp.ml, .mliocamllsp command availableoxlint.ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue, .astro, .svelteoxlint dependency in projectphp intelephense.phpAuto-installs for PHP projectsprisma.prismaprisma command availablepyright.py, .pyipyright dependency installedruby-lsp (rubocop).rb, .rake, .gemspec, .ruruby and gem commands availablerust.rsrust-analyzer command availablesourcekit-lsp.swift, .objc, .objcppswift installed (xcode on macOS)svelte.svelteAuto-installs for Svelte projectsterraform.tf, .tfvarsAuto-installs from GitHub releasestinymist.typ, .typcAuto-installs from GitHub releasestypescript.ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .ctstypescript dependency in projectvue.vueAuto-installs for Vue projectsyaml-ls.yaml, .ymlAuto-installs Red Hat yaml-language-serverzls.zig, .zonzig command available

LSP servers are automatically enabled when one of the above file extensions are detected and the requirements are met.

How It Works

When opencode opens a file, it:

  1. Checks the file extension against all enabled LSP servers.
  2. Starts the appropriate LSP server if not already running.

Configure

You can customize LSP servers through the lsp section in your opencode config.

{
"$schema": "https://opencode.ai/config.json",
"lsp": {}
}

Each LSP server supports the following:

PropertyTypeDescriptiondisabledbooleanSet this to true to disable the LSP servercommandstring[]The command to start the LSP serverextensionsstring[]File extensions this LSP server should handleenvobjectEnvironment variables to set when starting serverinitializationobjectInitialization options to send to the LSP server

Let’s look at some examples.

Environment variables

Use the env property to set environment variables when starting the LSP server:

{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"rust": {
"env": {
"RUST_LOG": "debug"
}
}
}
}

Initialization options

Use the initialization property to pass initialization options to the LSP server. These are server-specific settings sent during the LSP initialize request:

{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"typescript": {
"initialization": {
"preferences": {
"importModuleSpecifierPreference": "relative"
}
}
}
}
}

Disabling LSP servers

To disable all LSP servers globally, set lsp to false:

{
"$schema": "https://opencode.ai/config.json",
"lsp": false
}

To disable a specific LSP server, set disabled to true:

{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"typescript": {
"disabled": true
}
}
}

Custom LSP servers

You can add custom LSP servers by specifying the command and file extensions:

{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"custom-lsp": {
"command": ["custom-lsp-server", "--stdio"],
"extensions": [".custom"]
}
}
}

Additional Information

PHP Intelephense

PHP Intelephense offers premium features through a license key. You can provide a license key by placing (only) the key in a text file at:

  • On macOS/Linux: $HOME/intelephense/license.txt
  • On Windows: %USERPROFILE%/intelephense/license.txt

The file should contain only the license key with no additional content.