microsoft / microsoft/language-server-protocol

Is showMessageRequest optional, or supported by all clients?

Open
#1,635 23 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clarification
Dominant language
TypeScript
Stars
13k
Forks
1k
Avg merge
6d 1h
Merged PRs (30d)
10

Description

It's not clear to me if showMessageRequest is optional or to be supported by all clients. There is a showMessage field on Client Capabilities, but it appears to have only been added when support for additionalPropertiesSupport was added. This makes me think that showMessageRequest was already there (without any capabilities to say it's available).

However, the text in https://github.com/microsoft/language-server-protocol/issues/69#issuecomment-247768458 talks about when showMessageRequest was added, the showMessage notification was left in not to break existing clients, suggesting there may have been clients existing before showMessageRequest was added.

So is it safe for servers to assume showMessageRequest is always supported, and if not, should it be clearer from the ClientCapabilities.showMessage field that this indicates whether the server supports showMessageRequest at all?

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 ClientCapabilities.showMessage field and the linked language-server-protocol discussion and commit. Trace how the protocol describes showMessageRequest versus the showMessage notification, then clarify whether support is required and what the capability field means; done means the specification or issue has an unambiguous answer.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.