-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Add lsp-setup skill for configuring LSP servers in Copilot CLI #1272
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
brunoborges
wants to merge
3
commits into
staged
Choose a base branch
from
skill/lsp-setup
base: staged
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+496
−0
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| name: lsp-setup | ||
| description: 'Install and configure LSP servers for any programming language to work with GitHub Copilot CLI. Detects the OS, installs the right LSP server, and generates the LSP configuration (user-level or repo-level). Say "setup LSP" to start.' | ||
| --- | ||
|
|
||
| # LSP Setup for GitHub Copilot CLI | ||
|
|
||
| **UTILITY SKILL** — installs and configures Language Server Protocol servers for Copilot CLI. | ||
| USE FOR: "setup LSP", "install language server", "configure LSP for Java", "add TypeScript LSP", "enable code intelligence" | ||
| DO NOT USE FOR: general coding tasks, IDE/editor LSP configuration, non-Copilot-CLI setups | ||
|
|
||
| ## Workflow | ||
|
|
||
| 1. **Ask the language** — use `ask_user` to ask which programming language(s) the user wants LSP support for | ||
| 2. **Detect the OS** — run `uname -s` (or check for Windows via `$env:OS` / `%OS%`) to determine macOS, Linux, or Windows | ||
| 3. **Look up the LSP server** — read `references/lsp-servers.md` for known servers, install commands, and config snippets | ||
| 4. **Ask scope** — use `ask_user` to ask whether the config should be user-level (`~/.copilot/lsp-config.json`) or repo-level (`.github/lsp.json`) | ||
| 5. **Install the server** — run the appropriate install command for the detected OS | ||
| 6. **Write the config** — merge the new server entry into the chosen config file (`~/.copilot/lsp-config.json` for user-level, `.github/lsp.json` for repo-level); create it if missing, preserve existing entries | ||
| 7. **Verify** — confirm the LSP binary is on `$PATH` and the config file is valid JSON | ||
|
|
||
| ## Configuration Format | ||
|
|
||
| Copilot CLI reads LSP configuration from two locations (repo-level takes precedence): | ||
|
|
||
| - **User-level**: `~/.copilot/lsp-config.json` | ||
| - **Repo-level**: `.github/lsp.json` | ||
|
|
||
brunoborges marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| The JSON structure: | ||
|
|
||
| ```json | ||
| { | ||
| "lspServers": { | ||
| "<server-key>": { | ||
| "command": "<binary>", | ||
| "args": ["--stdio"], | ||
| "fileExtensions": { | ||
| ".<ext>": "<languageId>", | ||
| ".<ext2>": "<languageId>" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Key rules | ||
|
|
||
| - `command` is the binary name (must be on `$PATH`) or an absolute path. | ||
| - `args` almost always includes `"--stdio"` to use standard I/O transport. | ||
| - `fileExtensions` maps each file extension (with leading dot) to a [Language ID](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers). | ||
| - Multiple servers can coexist in `lspServers`. | ||
| - When merging into an existing file, **never overwrite** other server entries — only add or update the target language key. | ||
|
|
||
| ## Behavior | ||
|
|
||
| - Always use `ask_user` with `choices` when asking the user to pick a language or scope. | ||
| - If the language is not listed in `references/lsp-servers.md`, search the web for "<language> LSP server" and guide the user through manual configuration. | ||
| - If a package manager is not available (e.g. no Homebrew on macOS), suggest alternative install methods from the reference file. | ||
| - After installation, run `which <binary>` (or `where.exe` on Windows) to confirm the binary is accessible. | ||
| - Show the user the final config JSON before writing it. | ||
| - If the config file already exists, read it first and merge — do not clobber. | ||
|
|
||
| ## Verification | ||
|
|
||
| After setup, tell the user: | ||
|
|
||
| 1. Launch `copilot` in a project with files of the configured language | ||
| 2. Run `/lsp` to check the server status | ||
| 3. Try code intelligence features like go-to-definition or hover | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.