> ## Documentation Index
> Fetch the complete documentation index at: https://docs.symbioticsec.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# LSP

> Help the LLM understand your codebase with Language Server Protocol (LSP)

Symbiotic Code integrates with your [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) (LSP) to help the LLM interact with your codebase. It uses diagnostics to provide feedback to the LLM.

***

## Built-in LSP Servers

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

| LSP Server         | Extensions                                                          | Requirements                                                 |
| ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------ |
| astro              | .astro                                                              | Auto-installs for Astro projects                             |
| bash               | .sh, .bash, .zsh, .ksh                                              | Auto-installs bash-language-server                           |
| clangd             | .c, .cpp, .cc, .cxx, .c++, .h, .hpp, .hh, .hxx, .h++                | Auto-installs for C/C++ projects                             |
| csharp             | .cs                                                                 | `.NET SDK` installed                                         |
| clojure-lsp        | .clj, .cljs, .cljc, .edn                                            | `clojure-lsp` command available                              |
| dart               | .dart                                                               | `dart` command available                                     |
| deno               | .ts, .tsx, .js, .jsx, .mjs                                          | `deno` command available (auto-detects deno.json/deno.jsonc) |
| elixir-ls          | .ex, .exs                                                           | `elixir` command available                                   |
| eslint             | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue                  | `eslint` dependency in project                               |
| fsharp             | .fs, .fsi, .fsx, .fsscript                                          | `.NET SDK` installed                                         |
| gleam              | .gleam                                                              | `gleam` command available                                    |
| gopls              | .go                                                                 | `go` command available                                       |
| hls                | .hs, .lhs                                                           | `haskell-language-server-wrapper` command available          |
| jdtls              | .java                                                               | `Java SDK (version 21+)` installed                           |
| julials            | .jl                                                                 | `julia` and `LanguageServer.jl` installed                    |
| kotlin-ls          | .kt, .kts                                                           | Auto-installs for Kotlin projects                            |
| lua-ls             | .lua                                                                | Auto-installs for Lua projects                               |
| nixd               | .nix                                                                | `nixd` command available                                     |
| ocaml-lsp          | .ml, .mli                                                           | `ocamllsp` command available                                 |
| oxlint             | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue, .astro, .svelte | `oxlint` dependency in project                               |
| php intelephense   | .php                                                                | Auto-installs for PHP projects                               |
| prisma             | .prisma                                                             | `prisma` command available                                   |
| pyright            | .py, .pyi                                                           | `pyright` dependency installed                               |
| ruby-lsp (rubocop) | .rb, .rake, .gemspec, .ru                                           | `ruby` and `gem` commands available                          |
| rust               | .rs                                                                 | `rust-analyzer` command available                            |
| sourcekit-lsp      | .swift, .objc, .objcpp                                              | `swift` installed (`xcode` on macOS)                         |
| svelte             | .svelte                                                             | Auto-installs for Svelte projects                            |
| terraform          | .tf, .tfvars                                                        | Auto-installs from GitHub releases                           |
| tinymist           | .typ, .typc                                                         | Auto-installs from GitHub releases                           |
| typescript         | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts                        | `typescript` dependency in project                           |
| vue                | .vue                                                                | Auto-installs for Vue projects                               |
| yaml-ls            | .yaml, .yml                                                         | Auto-installs Red Hat yaml-language-server                   |
| zls                | .zig, .zon                                                          | `zig` command available                                      |

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

<Tip>
  You can disable automatic LSP server downloads by setting the `SYMBIOTIC_DISABLE_LSP_DOWNLOAD` environment variable to `true`.
</Tip>

***

## How it works

When Symbiotic Code 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 Symbiotic Code config.

```json title="symbiotic.json" theme={null}
{
  "$schema": "https://config.symbioticsec.ai/config.json",
  "lsp": {}
}
```

Each LSP server supports the following:

| Property         | Type      | Description                                       |
| ---------------- | --------- | ------------------------------------------------- |
| `disabled`       | boolean   | Set this to `true` to disable the LSP server      |
| `command`        | string\[] | The command to start the LSP server               |
| `extensions`     | string\[] | File extensions this LSP server should handle     |
| `env`            | object    | Environment variables to set when starting server |
| `initialization` | object    | Initialization 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:

```json title="symbiotic.json" {5-7} theme={null}
{
  "$schema": "https://config.symbioticsec.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:

```json title="symbiotic.json" {5-9} theme={null}
{
  "$schema": "https://config.symbioticsec.ai/config.json",
  "lsp": {
    "typescript": {
      "initialization": {
        "preferences": {
          "importModuleSpecifierPreference": "relative"
        }
      }
    }
  }
}
```

<Tip>
  Initialization options vary by LSP server. Check your LSP server's documentation for available options.
</Tip>

***

### Disabling LSP servers

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

```json title="symbiotic.json" {3} theme={null}
{
  "$schema": "https://config.symbioticsec.ai/config.json",
  "lsp": false
}
```

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

```json title="symbiotic.json" {5} theme={null}
{
  "$schema": "https://config.symbioticsec.ai/config.json",
  "lsp": {
    "typescript": {
      "disabled": true
    }
  }
}
```

***

### Custom LSP servers

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

```json title="symbiotic.json" {4-7} theme={null}
{
  "$schema": "https://config.symbioticsec.ai/config.json",
  "lsp": {
    "custom-lsp": {
      "command": ["custom-lsp-server", "--stdio"],
      "extensions": [".custom"]
    }
  }
}
```
