Language Server Protocol Specification

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/
Admin
The Language Server Protocol (LSP) is a JSON-RPC based protocol that defines a standard way for...
Tokens:120,281
Snippets:899
Trust Score:8.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Range example including line ending

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Example of a range that includes the entire line 5 including its line ending characters. The end position denotes the start of the next line.

```json
{
    start: { line: 5, character: 23 },
    end : { line: 6, character: 0 }
}

```

--------------------------------

### notebookDocumentSync server capability example

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Server capability example that synchronizes the whole notebook document including all Python cells to the server when the notebook is stored on disk. The notebookSelector uses a notebook filter with scheme 'file' and notebookType 'jupyter-notebook' and a cells selector for the 'python' language.

```json
{
	notebookDocumentSync: {
		notebookSelector: [
			{
				notebook: { scheme: 'file', notebookType: 'jupyter-notebook' },
				cells: [{ language: 'python' }]
			}
		]
	}
}

```

--------------------------------

### initialize

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

The initialize request is sent from the client to the server once after starting up the server. It initializes the language server and returns the server capabilities.

```APIDOC
## initialize

### Description
The initialize request is sent from the client to the server. It is sent once as the request after starting up the server. The request's parameter is of type {@link InitializeParams} and the response is of type {@link InitializeResult} or a Thenable that resolves to such.

### Method
initialize

### Message Direction
clientToServer

### Parameters
- **params** (InitializeParams) - Required - The initialization parameters.

### Result
- **result** (InitializeResult) - The result of the initialization.

### Error Data
- **errorData** (InitializeError) - Error data returned if initialization fails.
```

--------------------------------

### Example client/registerCapability JSON-RPC message

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Example JSON-RPC message to dynamically register for the 'textDocument/willSaveWaitUntil' feature on the client side. Only details are shown; the full message would include a 'jsonrpc' field and an 'id'.

```json
{
	"method": "client/registerCapability",
	"params": {
		"registrations": [
			{
				"id": "79eee87c-c409-4664-8102-e03263673f6f",
				"method": "textDocument/willSaveWaitUntil",
				"registerOptions": {
					"documentSelector": [
						{ "language": "javascript" }
					]
				}
			}
		]
	}
}
```

--------------------------------

### textDocument/reference request with progress tokens

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Example of a textDocument/reference request that includes both workDoneToken and partialResultToken to support progress reporting.

```json
{
	"textDocument": {
		"uri": "file:///folder/file.ts"
	},
	"position": {
		"line": 9,
		"character": 5
	},
	"context": {
		"includeDeclaration": true
	},
	// The token used to report work done progress.
	"workDoneToken": "1d546990-40a3-4b77-b134-46622995f6ae",
	// The token used to report partial result progress.
	"partialResultToken": "5f6f349e-4f81-4a3b-afff-ee04bff96804"
}
```

--------------------------------

### Base Protocol Message Example

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Shows the wire format of a base protocol message: a header with Content-Length followed by a JSON-RPC content part. The header and content are separated by '\r\n\r\n'.

```plaintext
Content-Length: ...\r\n
\r\n
{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "textDocument/completion",
	"params": {
		...
	}
}

```

--------------------------------

### Dynamic registration for workspace/didChangeWorkspaceFolders

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Example registration item for dynamically registering for the `workspace/didChangeWorkspaceFolders` notification. The `id` is a unique UUID used to unregister the capability, and `method` specifies the notification method.

```json
{
	id: "28c6150c-bd7b-11e7-abc4-cec278b6b50a",
	method: "workspace/didChangeWorkspaceFolders"
}
```

--------------------------------

### window/showDocument

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

A request to show a document. This request might open an external program depending on the value of the URI to open. For example a request to open https://code.visualstudio.com/ will very likely open the URI in a WEB browser. This method is available since version 3.16.0.

```APIDOC
## window/showDocument

### Description
A request to show a document. This request might open an
external program depending on the value of the URI to open.
For example a request to open `https://code.visualstudio.com/`
will very likely open the URI in a WEB browser.

@since 3.16.0

### Method
window/showDocument

### Message Direction
serverToClient

### Parameters
- **params** (ShowDocumentParams) - Required - The parameters for the request.

### Result
- **result** (ShowDocumentResult) - The result of the request.

### Since
3.16.0
```

--------------------------------

### Semantic tokens with absolute positions

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Example of three semantic tokens with absolute positions, using string token types and modifier names. This is the starting point for the encoding example.

```json
{ line: 2, startChar:  5, length: 3, tokenType: "property",
	tokenModifiers: ["private", "static"]
},
{ line: 2, startChar: 10, length: 4, tokenType: "type", tokenModifiers: [] },
{ line: 5, startChar:  2, length: 7, tokenType: "class", tokenModifiers: [] }

```

--------------------------------

### workspace/configuration

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Fetches configuration settings from the client. The request can fetch several configuration settings in one roundtrip. The order of the returned configuration settings corresponds to the order of the passed `ConfigurationItems`.

```APIDOC
## workspace/configuration

### Description
Fetches configuration settings from the client. The request can fetch several configuration settings in one roundtrip. The order of the returned configuration settings corresponds to the order of the passed `ConfigurationItems`.

### Method
workspace/configuration

### Endpoint
workspace/configuration

### Request
- **params** (`ConfigurationParams`) - Required - A set of configuration items to fetch.

  - `items` (`ConfigurationItem[]`) - Required - The configuration items to fetch.
    - `scopeUri` (`URI`) - Optional - The scope to get the configuration section for.
    - `section` (`string`) - Optional - The configuration section asked for.

### Response
- **result** (`LSPAny[]`) - The configuration settings in the same order as the request items.
- **error** - Code and message set in case an exception happens.
```

--------------------------------

### window/workDoneProgress/create

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress reporting from the server.

```APIDOC
## window/workDoneProgress/create

### Description
The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress reporting from the server.

### Method
POST

### Endpoint
window/workDoneProgress/create

### Parameters
#### Request Body
- **params** (WorkDoneProgressCreateParams) - Required - The parameters for creating a work done progress.

### Response
#### Success Response (200)
- **result** (null) - Always null.

### Response Example
{
  "result": null
}
```

--------------------------------

### Unregister Capability: UnregistrationParams and JSON-RPC example

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

The client/unregisterCapability request unregisters a previously registered capability. The Unregistration interface defines the id and method to unregister, while UnregistrationParams contains the list (note the misspelled 'unregisterations' field). The JSON-RPC example unregisters the textDocument/willSaveWaitUntil feature.

```typescript
/**
 * General parameters to unregister a capability.
 */
export interface Unregistration {
	/**
	 * The id used to unregister the request or notification. Usually an id
	 * provided during the register request.
	 */
	id: string;

	/**
	 * The method / capability to unregister for.
	 */
	method: string;
}

```

```typescript
export interface UnregistrationParams {
	// This should correctly be named `unregistrations`. However changing this
	// is a breaking change and needs to wait until we deliver a 4.x version
	// of the specification.
	unregisterations: Unregistration[];
}

```

```json
{
	"method": "client/unregisterCapability",
	"params": {
		"unregisterations": [
			{
				"id": "79eee87c-c409-4664-8102-e03263673f6f",
				"method": "textDocument/willSaveWaitUntil"
			}
		]
	}
}

```

--------------------------------

### Server-Initiated Progress Client Capability window.workDoneProgress

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Server-initiated progress requires the client to signal support via the window.workDoneProgress client capability. The token from window/workDoneProgress/create should be used only once (one begin, many report, one end).

```typescript
	/**
	 * Window specific client capabilities.
	 */
	window?: {
		/**
		 * Whether client supports server initiated progress using the
		 * `window/workDoneProgress/create` request.
		 */
		workDoneProgress?: boolean;
	};

```

--------------------------------

### textDocument/implementation

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

The go to implementation request is sent from the client to the server to resolve the implementation location of a symbol at a given text document position.

```APIDOC
## textDocument/implementation

### Description
The go to implementation request is sent from the client to the server to resolve the implementation location of a symbol at a given text document position.

### Method
POST

### Endpoint
`textDocument/implementation`

### Parameters
#### Request Params
- **textDocument** (TextDocumentIdentifier) - Required - The text document that contains the position.
- **position** (Position) - Required - The position inside the text document where the symbol is defined.
- **workDoneToken** (ProgressToken) - Optional - A token that can be used to report progress.
- **partialResultToken** (ProgressToken) - Optional - A token that can be used to report partial results.

### Response
#### Success Response (200)
- **result** (Location | Location[] | LocationLink[] | null) - Required - The implementation locations of the symbol at the given position.
- **partialResult** (Location[] | LocationLink[]) - Optional - Partial results for the request.
- **error** (ResponseError) - Optional - Code and message set in case an exception happens during the definition request.

#### Error Response
- **error.code** (integer) - Required - The error code.
- **error.message** (string) - Required - The error message.

```

--------------------------------

### textDocument/semanticTokens/full

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

A request to get semantic tokens for a document. This method is available since version 3.16.0.

```APIDOC
## textDocument/semanticTokens/full

### Description
@since 3.16.0

### Method
textDocument/semanticTokens/full

### Message Direction
clientToServer

### Parameters
- **params** (SemanticTokensParams) - Required - The parameters for the request.

### Result
- **result** (SemanticTokens | null) - The semantic tokens for the document, or null if none.

### Partial Result
- **partialResult** (SemanticTokensPartialResult) - A partial result for the request.

### Registration Method
textDocument/semanticTokens

### Registration Options
- **registrationOptions** (SemanticTokensRegistrationOptions) - The registration options for the request.

### Since
3.16.0
```

--------------------------------

### textDocument/semanticTokens/range

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

A request to get semantic tokens for a range in a document. This method is available since version 3.16.0.

```APIDOC
## textDocument/semanticTokens/range

### Description
@since 3.16.0

### Method
textDocument/semanticTokens/range

### Message Direction
clientToServer

### Parameters
- **params** (SemanticTokensRangeParams) - Required - The parameters for the request.

### Result
- **result** (SemanticTokens | null) - The semantic tokens for the range, or null if none.

### Partial Result
- **partialResult** (SemanticTokensPartialResult) - A partial result for the request.

### Registration Method
textDocument/semanticTokens

### Since
3.16.0
```

--------------------------------

### textDocument/semanticTokens/full/delta

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

A request to get semantic tokens delta for a document. This method is available since version 3.16.0.

```APIDOC
## textDocument/semanticTokens/full/delta

### Description
@since 3.16.0

### Method
textDocument/semanticTokens/full/delta

### Message Direction
clientToServer

### Parameters
- **params** (SemanticTokensDeltaParams) - Required - The parameters for the request.

### Result
- **result** (SemanticTokens | SemanticTokensDelta | null) - The semantic tokens delta, or null if none.

### Partial Result
- **partialResult** (SemanticTokensPartialResult | SemanticTokensDeltaPartialResult) - A partial result for the request.

### Registration Method
textDocument/semanticTokens

### Registration Options
- **registrationOptions** (SemanticTokensRegistrationOptions) - The registration options for the request.

### Since
3.16.0
```

--------------------------------

### CreateFileOptions interface

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Options for the create file operation. `overwrite` wins over `ignoreIfExists` when both are set.

```typescript
/**
 * Options to create a file.
 */
export interface CreateFileOptions {
	/**
	 * Overwrite existing file. Overwrite wins over `ignoreIfExists`
	 */
	overwrite?: boolean;

	/**
	 * Ignore if exists.
	 */
	ignoreIfExists?: boolean;
}

```

--------------------------------

### Range interface

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Defines a range in a text document as a start and end position. The end position is exclusive.

```typescript
interface Range {
	/**
	 * The range's start position.
	 */
	start: Position;

	/**
	 * The range's end position.
	 */
	end: Position;
}

```

--------------------------------

### window/showMessage

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

Sent from a server to a client to ask the client to display a particular message in the user interface.

```APIDOC
## window/showMessage

### Description
The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.

### Message Direction
serverToClient

### Method
window/showMessage

### Parameters
- **ShowMessageParams** (reference) - Required - The parameters for the show message notification.
```

--------------------------------

### textDocument/moniker

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

A request to get the moniker of a symbol at a given text document position. The response is an array of Moniker objects or null.

```APIDOC
## textDocument/moniker

### Description
A request to get the moniker of a symbol at a given text document position. The request parameter is of type {@link TextDocumentPositionParams}. The response is of type {@link Moniker Moniker[]} or `null`.

### Method
Request (clientToServer)

### Endpoint
textDocument/moniker

### Parameters
#### Params
- **MonikerParams** (reference) - Required - The parameters for the moniker request.

#### Registration Options
- **MonikerRegistrationOptions** (reference) - Required - The registration options for moniker.

### Result
- **Moniker[]** or **null** - The moniker(s) of the symbol at the given position.

### Partial Result
- **Moniker[]** - Partial results for the moniker request.
```

--------------------------------

### DidChangeWatchedFilesRegistrationOptions interface

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Registration options for file system change events. Contains the watchers to register.

```typescript
/**
 * Describe options to be used when registering for file system change events.
 */
export interface DidChangeWatchedFilesRegistrationOptions {
	/**
	 * The watchers to register.
	 */
	watchers: FileSystemWatcher[];
}

```

--------------------------------

### FileSystemWatcher interface

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Describes a file system watcher. The globPattern is required; kind defaults to WatchKind.Create | WatchKind.Change | WatchKind.Delete (7) if omitted.

```typescript
export interface FileSystemWatcher {
	/**
	 * The glob pattern to watch. See {@link GlobPattern glob pattern}
	 * for more detail.
	 *
 	 * @since 3.17.0 support for relative patterns.
	 */
	globPattern: GlobPattern;

	/**
	 * The kind of events of interest. If omitted it defaults
	 * to WatchKind.Create | WatchKind.Change | WatchKind.Delete
	 * which is 7.
	 */
	kind?: WatchKind;
}

```

--------------------------------

### window/showDocument

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

A request sent from the server to the client to display a resource identified by a URI in the user interface.

```APIDOC
## window/showDocument

### Description
A request from the server to the client to display a resource (e.g., a document) in the user interface. Available since version 3.16.0.

### Method
Request

### Endpoint
window/showDocument

### Parameters
#### Client Capability
- **support** (boolean) - Required - Indicates whether the client supports the show document request.

#### Params
- **uri** (URI) - Required - The URI of the resource to show.
- **external** (boolean) - Optional - If true, show the resource in an external program (e.g., web browser).
- **takeFocus** (boolean) - Optional - Indicates whether the editor showing the document should take focus.
- **selection** (Range) - Optional - A selection range if the document is a text document.

### Request Example
{
  "uri": "file:///path/to/file",
  "external": false,
  "takeFocus": true,
  "selection": {
    "start": { "line": 0, "character": 0 },
    "end": { "line": 0, "character": 10 }
  }
}

### Response
#### Result
- **success** (boolean) - Indicates whether the show was successful.

#### Error
Code and message set in case an exception happens.

```

--------------------------------

### workspace/willCreateFiles

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client. It can return a WorkspaceEdit to be applied before the files are created.

```APIDOC
## workspace/willCreateFiles

### Description
The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client. The request can return a `WorkspaceEdit` which will be applied to workspace before the files are created. Hence the `WorkspaceEdit` can not manipulate the content of the file to be created.

### Method
Request (clientToServer)

### Endpoint
workspace/willCreateFiles

### Parameters
#### Params
- **CreateFilesParams** (reference) - Required - The parameters for the will create files request.

#### Registration Options
- **FileOperationRegistrationOptions** (reference) - Required - The registration options for file operations.

### Result
- **WorkspaceEdit** or **null** - The workspace edit to apply before files are created.

### Since
3.16.0
```

--------------------------------

### window/showMessageRequest

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json

The show message request is sent from the server to the client to show a message and a set of option actions to the user.

```APIDOC
## window/showMessageRequest

### Description
The show message request is sent from the server to the client to show a message and a set of options actions to the user.

### Method
window/showMessageRequest

### Message Direction
serverToClient

### Parameters
- **params** (ShowMessageRequestParams) - Required - The parameters for the show message request.

### Result
- **result** (MessageActionItem | null) - The action item selected by the user, or null.
```

--------------------------------

### workspaceSymbol/resolve

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Resolves additional information for a given workspace symbol. The request is sent from the client to the server.

### Method
workspaceSymbol/resolve

### Endpoint
workspaceSymbol/resolve

### Request
- **params** (`WorkspaceSymbol`) - Required - The workspace symbol to resolve.

### Response
- **result** (`WorkspaceSymbol`) - The resolved workspace symbol.
- **error** - Code and message set in case an exception happens during the resolve request.

```APIDOC
## workspaceSymbol/resolve

### Description
Resolves additional information for a given workspace symbol. The request is sent from the client to the server.

### Method
workspaceSymbol/resolve

### Endpoint
workspaceSymbol/resolve

### Request
- **params** (`WorkspaceSymbol`) - Required - The workspace symbol to resolve.

### Response
- **result** (`WorkspaceSymbol`) - The resolved workspace symbol.
- **error** - Code and message set in case an exception happens during the resolve request.
```

--------------------------------

### CreateFile interface

Source: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification

Create file operation literal. Requires `kind: 'create'`, a `DocumentUri`, and optional `CreateFileOptions` and `annotationId` (since 3.16.0).

```typescript
/**
 * Create file operation
 */
export interface CreateFile {
	/**
	 * A create
	 */
	kind: 'create';

	/**
	 * The resource to create.
	 */
	uri: DocumentUri;

	/**
	 * Additional options
	 */
	options?: CreateFileOptions;

	/**
	 * An optional annotation identifier describing the operation.
	 *
	 * @since 3.16.0
	 */
	annotationId?: ChangeAnnotationIdentifier;
}

```
Tokens:
Raw