microsoft / microsoft/language-server-protocol

[Feature] ServerInfo request

Open
#558 7 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request good first issue help wanted new request
Dominant language
TypeScript
Stars
13k
Forks
1k
Avg merge
6d 1h
Merged PRs (30d)
10

Description

For monitoring and troubleshooting the Language Server, it is extremely useful to have server information printer in the editor. Most Vim clients either don't provide any way of printing out LSP server address, log file, etc or use their own format (e.g. here's my request for a Vim client). It might be useful for both users and LSP developers to provide a unified request (workspace/serverInfo?) and server information format. There are few things we could ask from every server:

  • Server PID (so that I could attach my debugger to the process)
  • Log files: both stdout and sterr files
  • URL
  • Memory consumption
  • Additional (optional) server information string which can be specific to each server (e.g. which one is used, what the version is, etc)

Having this information would provide better user experience for bug submissions and better developer experience. Alternatively, we could allow servers to return a string in free format letting each server decide what they would like to expose to the client.

This is an example of server information printer in Vim's YouCompleteMe:

43989813-6e98d63a-9d51-11e8-93a1-62125c874c88

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed workspace/serverInfo request and the listed server details: PID, logs, URL, memory, and an optional information string. Done means agreeing on a unified request and response format, including whether free-form server output is supported, and updating the protocol specification accordingly.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.