Lsproxy Docs

Get Started

API Reference

Returns the contents of the specified file.

Read source code from a file in the workspace

A position within a text document, using 0-based indexing

0-indexed character index within the line.

A range within a specific file, defined by start and end positions

bearer auth

Language Specifics (In Progress)

Returns a list of symbols (functions, classes, variables, etc.) defined in the specified file.

Only the variabels defined at the file level are included.

The returned positions point to the start of the symbol's identifier.

e.g. for `User` on line 0 of `src/main.py`:
```
0: class User:
_________^
1:     def __init__(self, name, age):
2:         self.name = name
3:         self.age = age
```

Get symbols in a specific file (uses ast-grep)

Returns the location of the definition for the symbol at the given position.

The input position should point inside the symbol's identifier, e.g.

The returned position points to the identifier of the symbol, and the file_path from workspace root

e.g. for the definition of `User` on line 5 of `src/main.py` with the code:
```
0: class User:
output___^
1:     def __init__(self, name, age):
2:         self.name = name
3:         self.age = age
4:
5: user = User("John", 30)
input_____^^^^
```

Get the definition of a symbol at a specific position in a file

Given a file path and identifier name, returns:
- Without position: All matching identifiers in the file
- With position: The exact identifier with that name at that position, or 3 closest identifiers with that name

Example finding all occurrences of "user_name":
```
let user_name = "John";  // First occurrence
println!("{}", user_name); // Second occurrence
```

When a position is provided, it searches for an exact match at that location.
If no exact match exists, returns the 3 identifiers closest to the position
based on line and character distance, prioritizing lines.

Finds occurrences of an identifier by name in a file

Returns references categorized into:
- Workspace symbols (with their definitions)
- External symbols (built-in functions like 'len', 'print' or from external libraries)
- Symbols that couldn't be found

e.g. for a function in `main.py`:
```python
@log_execution_time     # Reference to decorator
def process_user():
    user = User()       # Reference to User class
    print("Done")       # Reference to built-in function
```
This would return:
- Workspace symbols: log_execution_time (with definition from decorators.py)
- Workspace symbols: User (with definition from models.py)
- External symbols: print (Python built-in)

Find all symbols that are referenced from a given position

The input position should point to the identifier of the symbol you want to get the references for.

Returns a list of locations where the symbol at the given position is referenced.

The returned positions point to the start of the reference identifier.

e.g. for `User` on line 0 of `src/main.py`:
```
 0: class User:
 input____^^^^
 1:     def __init__(self, name, age):
 2:         self.name = name
 3:         self.age = age
 4:
 5: user = User("John", 30)
 output____^
```

Find all references to a symbol

Returns the service status, version and language server availability

Get health status of the LSP proxy service

Returns an array of file paths for all files in the current workspace.

This is a convenience endpoint that does not use the underlying Language Servers directly, but it does apply the same filtering.

symbol

system

workspace

Read source code from a file in the workspace

Authorizations

Body

Response