Skip to content

Commit 6914b0c

Browse files
committed
update readme
1 parent 91a0d96 commit 6914b0c

File tree

1 file changed

+17
-34
lines changed

1 file changed

+17
-34
lines changed

README.md

Lines changed: 17 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,9 @@ This codebase makes use of edited code from [gopls](https://go.googlesource.com/
2525
[mcp-golang](https://github.com/metoro-io/mcp-golang) is used for MCP communication.
2626

2727
## Prerequisites
28-
Install Go:
28+
Install Go: Follow instructions at https://golang.org/doc/install
2929

30-
macOS: `brew install go`
31-
Linux: Follow instructions at https://golang.org/doc/install
32-
Windows: Download from https://golang.org/dl/
33-
34-
Install the required language server for your codebase:
30+
Install a language server for your codebase:
3531

3632
- Python (pyright): `npm install -g pyright`
3733
- TypeScript (tsserver): `npm install -g typescript typescript-language-server`
@@ -40,7 +36,8 @@ Install the required language server for your codebase:
4036
- Or use any language server
4137

4238
## Setup
43-
Add the following configuration to your Claude Desktop settings (or similar MCP-enabled client):
39+
Add something like the following configuration to your Claude Desktop settings (or similar MCP-enabled client):
40+
4441
```json
4542
{
4643
"mcpServers": {
@@ -50,59 +47,45 @@ Add the following configuration to your Claude Desktop settings (or similar MCP-
5047
"run",
5148
"github.com/isaacphi/mcp-language-server/cmd/server",
5249
"--workspace",
53-
"/full/path/to/code/workspace",
50+
"/Users/you/dev/yourpythoncodebase",
5451
"--lsp",
55-
"/full/path/to/languageserver/executable",
52+
"/opt/homebrew/bin/pyright",
5653
"--",
57-
"lsp-args"
54+
"--stdio"
5855
],
5956
"env": {
60-
"OPTIONAL_ENV": "1"
57+
"DEBUG": "1"
6158
}
6259
}
6360
}
6461
}
6562
```
63+
6664
Replace:
6765

68-
- /full/path/to/code/workspace with the absolute path to your project
69-
- /full/path/to/languageserver/executable with the path to your language server (found using `which` command e.g. `which pyright`)
66+
- /Users/you/dev/yourpythoncodebase with the absolute path to your project
67+
- /opt/homebrew/bin/pyright with the path to your language server (found using `which` command e.g. `which pyright`)
7068
- Any aruments after `--` are sent as arguments to your language server.
7169
- Any env variables are passed on to the language server. Some may be necessary for you language server. For example, `gopls` required `GOPATH` and `GOCACHE` in order for me to get it working properly.
70+
- `DEBUG=1` is optional. See below.
7271

7372
For example, for python it might look like
7473

75-
```json
76-
{
77-
"mcpServers": {
78-
"language-server": {
79-
"command": "go",
80-
"args": [
81-
"run",
82-
"github.com/isaacphi/mcp-language-server/cmd/server",
83-
"--workspace",
84-
"/Users/isaacphi/dev/yourcodebase",
85-
"--lsp",
86-
"/opt/homebrew/bin/pyright",
87-
"--",
88-
"--stdio"
89-
],
90-
}
91-
}
92-
}
93-
```
94-
9574
## Feedback
9675

9776
Include
98-
```json
77+
```
9978
env: {
10079
"DEBUG": 1
10180
}
10281
```
10382
To get detailed LSP and application logs. Please include as much information as possible when opening issues.
10483

10584
This is an early release and some of the following features are on my radar:
85+
- [x] Read definition
86+
- [x] Get references
87+
- [x] Apply edit
88+
- [x] Get diagnostics
10689
- [ ] Code lens
10790
- [ ] Hover actions
10891
- [ ] Better handling of context and cancellation

0 commit comments

Comments
 (0)