feat: add Go LSP configuration and code navigation documentation

ThomasK33 · ThomasK33 · commit 52fa7f3d1338 · 2025-06-26T19:06:55.000+02:00
Change-Id: I994c8ee8fa2c246808a9f68a86e83a6a3db6f8ac
Signed-off-by: Thomas Kosiewski &lt;tk@coder.com&gt;
diff --git a/.claude/settings.json b/.claude/settings.json
@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [],
+    "deny": [
+      "mcp__go-language-server__edit_file"
+    ]
+  }
+}
diff --git a/.mcp.json b/.mcp.json
@@ -0,0 +1,20 @@
+{
+	"mcpServers": {
+		"go-language-server": {
+			"type": "stdio",
+			"command": "go",
+			"args": [
+				"run",
+				"github.com/isaacphi/mcp-language-server@latest",
+				"-workspace",
+				"./",
+				"-lsp",
+				"go",
+				"--",
+				"run",
+				"golang.org/x/tools/gopls@latest"
+			],
+			"env": {}
+		}
+	}
+}
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -270,6 +270,50 @@ if errors.Is(err, errInvalidPKCE) {
 - Test both positive and negative cases
 - Use `testutil.WaitLong` for timeouts in tests
 
+## Code Navigation and Investigation
+
+### Using Go LSP Tools
+
+When working with the Coder codebase, leverage Go Language Server Protocol tools for efficient code navigation:
+
+1. **Find function definitions**:
+
+   ```none
+   mcp__go-language-server__definition symbolName
+   ```
+
+   - Example: `mcp__go-language-server__definition getOAuth2ProviderAppAuthorize`
+   - Quickly jump to function implementations across packages
+
+2. **Find symbol references**:
+
+   ```none
+   mcp__go-language-server__references symbolName
+   ```
+
+   - Locate all usages of functions, types, or variables
+   - Understand code dependencies and call patterns
+
+3. **Get symbol information**:
+
+   ```none
+   mcp__go-language-server__hover filePath line column
+   ```
+
+   - Get type information and documentation at specific positions
+
+4. **When to use LSP vs other tools**:
+   - **Use LSP for**: Following function calls, understanding package relationships, finding specific implementations
+   - **Use Grep for**: Text-based searches, finding patterns across files
+   - **Use Bash for**: Simple file operations, running tests, git commands
+
+### Investigation Strategy
+
+1. **Start with route registration** in `coderd/coderd.go` to understand API endpoints
+2. **Use LSP definition lookup** to trace from route handlers to actual implementations
+3. **Follow the middleware chain** to understand request processing flow
+4. **Check test files** for expected behavior and error patterns
+
 ## Testing Scripts
 
 ### OAuth2 Test Scripts
