microsoft / microsoft/language-server-protocol

Add a free-text "description" field to `serverInfo`

Open
#1,752 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

It would be nice to have a free-text (or perhaps markdown) field in serverInfo for the server to provide any server-specific information that it thinks the user might want to see.

Here's an example. The Haskell language server supports different features depending which version of the Haskell compiler it is built for (typically we start with partial support for a new compiler version and then add more over time). This means that users can be surprised that some feature is not available. At the moment, we have no easy way of conveying this to the user. The information is HLS-specific, so it's not clear that we could have a standard format for "server features". The simplest thing would just be to have a free text field so the server can put whatever it wants in there.

We can of course emit this information to the log, but it would be nice for users to have a standard place where static information about the server was recorded.

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 locating the serverInfo definition in the language server protocol specification and review how existing server metadata fields are represented. Decide whether the new value is plain text or markdown, where it belongs, and how clients should expose it; done means the protocol shape and its intended client-facing semantics are clearly specified.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.