MCP Gopls

🚀 MCP-GOPLS

An MCP (Model Context Protocol) server that wraps gopls to provide Go language server features.

⚠️ Important Note

This entire project was generated by Claude Code without human code review. While it passes tests and appears functional, please use with EXTREME CAUTION in production environments. The code has not been audited for security, performance, or edge cases. See DESIGN.md for the AI-generated design document.

🚀 Quick Start

MCP-GOPLS is an MCP server that wraps gopls, enabling you to leverage gopls features for Go language development. You can quickly start using it by following the installation steps below.

✨ Features

All gopls language server features are now implemented:

• GoToDefinition: Navigate to the definition of a symbol
• FindReferences: Find all references to a symbol
• GetDiagnostics: Get compile errors and static analysis findings
• Hover: Get information about symbols under the cursor
• SearchSymbol: Search for symbols across the workspace (supports partial matching)
• RenameSymbol: Rename symbols across the workspace (applies changes directly to files)
• FindImplementers: Find all types that implement an interface
• ListDocumentSymbols: Get an outline of symbols defined in a file
• FormatCode: Format Go source code according to gofmt standards (applies changes to files)
• OrganizeImports: Organize import statements (groups and sorts imports, applies changes to files)

📦 Installation

go install github.com/yantrio/mcp-gopls/cmd/mcp-gopls@latest

💻 Usage Examples

Basic Usage

# Run with default settings (uses gopls in PATH and current directory as workspace)
mcp-gopls

Advanced Usage

# Specify gopls path and workspace
mcp-gopls -gopls /path/to/gopls -workspace /path/to/project

# Using environment variables
export GOPLS_PATH=/path/to/gopls
export MCP_GOPLS_WORKSPACE=/path/to/project
mcp-gopls

📚 Documentation

Integration with Claude

Claude Code

1. Install mcp-gopls:

   go install github.com/yantrio/mcp-gopls/cmd/mcp-gopls@latest
   

2. Add to Claude Code:

   claude mcp add mcp-gopls "$(which mcp-gopls)"
   

3. Restart Claude Code:

   claude restart
   

4. Verify installation:

   claude mcp list
   

Claude Desktop

1. Install mcp-gopls (same as above)

2. Edit Claude Desktop configuration:

   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json
   • Linux: ~/.config/Claude/claude_desktop_config.json

3. Add the following to the mcpServers section:

   {
     "mcpServers": {
       "mcp-gopls": {
         "command": "mcp-gopls",
         "args": []
       }
     }
   }
   

   Or with custom workspace:

   {
     "mcpServers": {
       "mcp-gopls": {
         "command": "mcp-gopls",
         "args": ["-workspace", "/path/to/your/go/project"]
       }
     }
   }
   

4. Restart Claude Desktop

Requirements

• Go 1.24.3+
• gopls (Go language server)

Installing gopls

go install golang.org/x/tools/gopls@latest

Development

# Clone the repository
git clone https://github.com/yantrio/mcp-gopls
cd mcp-gopls

# Build the project
go build ./cmd/mcp-gopls

# Run tests
go test ./...

📄 License

MIT