A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
docs for supported LSPs (#8463)
Shahmir Varqhaddafb8a00e97
diff --git a/docs/guides/editor_features/language_server.md b/docs/guides/editor_features/language_server.mdindex 914ffd1239..746d840585 100644--- a/docs/guides/editor_features/language_server.md+++ b/docs/guides/editor_features/language_server.md@@ -7,9 +7,18 @@ The marimo editor supports the Language Server Protocol (LSP) to provide enhance- Go to definition- Error checking and diagnostics-## Installation+Multiple language servers can be run simultaneously. When+enabled, their results are merged — for example, you can+get completions from pylsp and diagnostics from basedpyright at the same time.-LSP support requires additional dependencies. You can install them with:+## Supported language servers++### pylsp (python-lsp-server)++The core Python language server providing completions, hover, go-to-definition,+diagnostics, code actions, rename, and signature help.++**Install:**```bashpip install "marimo[lsp]"@@ -19,47 +28,128 @@ uv add "marimo[lsp]"conda install -c conda-forge python-lsp-server python-lsp-ruff```-This will install the necessary packages including:+This installs:- [`python-lsp-server`](https://github.com/python-lsp/python-lsp-server): The core Python language server-- `python-lsp-ruff`: Ruff integration for fast linting--You may optionally install other `pylsp` plugins.+- [`python-lsp-ruff`](https://github.com/python-lsp/python-lsp-ruff): Ruff integration for fast linting-!!! note "Other Python Language Servers"+You may optionally install other `pylsp` plugins (e.g. `pylsp-mypy`).- Support for other Python language servers is planned for future releases.--## Configuration--LSP support can be configured in your `pyproject.toml` file.+**Configuration:**```toml title="pyproject.toml"--# Language server configuration[tool.marimo.language_servers.pylsp]-enabled = true # Enable/disable the Python language server+enabled = true # Enable/disable pylspenable_mypy = true # Type checking with mypy (enabled by default, if installed)enable_ruff = true # Linting with ruff (enabled by default, if installed)enable_flake8 = false # Linting with flake8enable_pydocstyle = false # Check docstring styleenable_pylint = false # Linting with pylintenable_pyflakes = false # Syntax checking with pyflakes+```++### basedpyright++A type checker for Python built on Pyright. In marimo, basedpyright is used+for **diagnostics only** (type checking errors and warnings).++**Install:**++```bash+uv pip install basedpyright+```-# Diagnostics configuration+**Configuration:**++```toml title="pyproject.toml"+[tool.marimo.language_servers.basedpyright]+enabled = true+```++See the [basedpyright docs](https://docs.basedpyright.com) for more information.++### ty++A type checker for Python from [Astral](https://astral.sh/) (the creators of+Ruff). In marimo, ty is used for **diagnostics only**.++**Install:**++```bash+uv pip install ty+```++**Configuration:**++```toml title="pyproject.toml"+[tool.marimo.language_servers.ty]+enabled = true+```++See the [ty repository](https://github.com/astral-sh/ty) for more information.++### pyrefly++A type checker for Python from Meta. Pyrefly provides completions, hover,+go-to-definition, and diagnostics.++**Install:**++```bash+uv pip install pyrefly+```++**Configuration:**++```toml title="pyproject.toml"+[tool.marimo.language_servers.pyrefly]+enabled = true+```++See the [pyrefly repository](https://github.com/facebook/pyrefly) for more information.++### GitHub Copilot++AI-powered code completions via the GitHub Copilot language server. Copilot is+configured separately from the other language servers through the completion+settings.++**Configuration:**++```toml title="pyproject.toml"+[tool.marimo.completion]+copilot = "github"+```++See the [AI completion guide](ai_completion.md#github-copilot) for+more details on Copilot setup and configuration.++## Using multiple language servers++You can enable multiple language servers at once. marimo uses a federated+architecture that merges results from all active servers. For example, you might+use pylsp for completions and code actions while relying on basedpyright or ty+for stricter type-checking diagnostics.++## Diagnostics++Diagnostics from all language servers can be toggled globally:++```toml title="pyproject.toml"[tool.marimo.diagnostics]enabled = true # Show diagnostics in the editor```## WebAssembly-Language Servers are not available when running marimo in WebAssembly.+Language servers are not available when running marimo in WebAssembly.## Troubleshooting-If you encounter issues with the language server:+If you encounter issues with a language server:-1. Make sure you've installed the required dependencies with `pip install "marimo[lsp]"`-2. Check if the language server is enabled in your configuration-3. Try restarting the marimo server-4. Check the terminal for any error messages+1. Make sure you've installed the required dependencies with `uv pip install "marimo[lsp]"`+2. For basedpyright, ty, and pyrefly, ensure [Node.js](https://nodejs.org/) is installed+3. Check if the language server is enabled in your configuration+4. Try restarting the marimo server+5. Check the terminal for error messages or the log files in your marimo log directory (e.g. `~/.cache/marimo/logs/`)