mirror of
https://github.com/github/awesome-copilot.git
synced 2026-04-11 02:35:55 +00:00
Rewrite description to emphasize code intelligence capabilities (go-to-definition, find-references, hover) so the coding agent triggers the skill when it needs deeper code understanding, while still matching explicit LSP setup/configuration requests. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
3.5 KiB
3.5 KiB
name, description
| name | description |
|---|---|
| lsp-setup | Enable code intelligence (go-to-definition, find-references, hover, type info) for any programming language by installing and configuring an LSP server for Copilot CLI. Detects the OS, installs the right server, and generates the JSON configuration (user-level or repo-level). Use when you need deeper code understanding and no LSP server is configured, or when the user asks to set up, install, or configure an LSP server. |
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", "I need go-to-definition", "find references not working", "need better code understanding" DO NOT USE FOR: general coding tasks, IDE/editor LSP configuration, non-Copilot-CLI setups
Workflow
- Ask the language — use
ask_userto ask which programming language(s) the user wants LSP support for - Detect the OS — run
uname -s(or check for Windows via$env:OS/%OS%) to determine macOS, Linux, or Windows - Look up the LSP server — read
references/lsp-servers.mdfor known servers, install commands, and config snippets - Ask scope — use
ask_userto ask whether the config should be user-level (~/.copilot/lsp-config.json) or repo-level (.github/lsp.json) - Install the server — run the appropriate install command for the detected OS
- Write the config — merge the new server entry into the chosen config file (
~/.copilot/lsp-config.jsonfor user-level,.github/lsp.jsonfor repo-level); create it if missing, preserve existing entries - Verify — confirm the LSP binary is on
$PATHand 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
The JSON structure:
{
"lspServers": {
"<server-key>": {
"command": "<binary>",
"args": ["--stdio"],
"fileExtensions": {
".<ext>": "<languageId>",
".<ext2>": "<languageId>"
}
}
}
}
Key rules
commandis the binary name (must be on$PATH) or an absolute path.argsalmost always includes"--stdio"to use standard I/O transport.fileExtensionsmaps each file extension (with leading dot) to a Language ID.- 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_userwithchoiceswhen asking the user to pick a language or scope. - If the language is not listed in
references/lsp-servers.md, search the web for " 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>(orwhere.exeon 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:
- Launch
copilotin a project with files of the configured language - Run
/lspto check the server status - Try code intelligence features like go-to-definition or hover