Go Dev MCP

🚀 GoDevMCP Development Tool

GoDevMCP provides convenient tools for Go development and integrates the Model Context Protocol (MCP) functionality.

🚀 Quick Start

✨ Features

• run_make: Execute common development task commands.
• tree_dir: Return the tree structure of the project directory for easy navigation.
• search_godoc: Search for Go packages on pkg.go.dev and return matching results.
• read_godoc: Retrieve and display the documentation of a specific Go package.

📦 Installation

Prerequisites

• You need to install the GitHub gh command-line tool.

Install using go install

You can directly use Go's installation command to install:

go install fujlog.net/godev-mcp/godevmcp@latest

This will download, compile, and install the binary file to your $GOPATH/bin directory (usually ~/go/bin). Please ensure that this directory has been added to the system PATH environment variable.

Build from source

1. Clone the repository.
2. Run make build to build the application and make install to install it.

VSCode Configuration

Add the following content to the user's settings.json:

    "mcp": {
        "servers": {
            "go-dev-mcp": {
                "type": "stdio",
                "command": "godevmcp",
                "args": [
                    "serve"
                ],
            }
        }
    }

💻 Usage Examples

Toolset

run_make

Execute common development task commands.

tree_dir

Return the tree structure of the project directory for easy navigation.

search_godoc

Search for Go packages on pkg.go.dev and return matching results.

Usage:

search_godoc query

Example:

search_godoc html

This will search for packages related to "html" and return the matching packages and their description information.

read_godoc

Retrieve and display the documentation of a specific Go package.

Usage:

read_godoc package_url

Example:

read_godoc golang.org/x/net/html

This will retrieve the documentation of the specified package, including descriptions, functions, types, and example content.

Using the Application

1. Build the application

   make build
   

2. Run the application

   make run
   

📚 Documentation

Available Make Commands

• make run - Run the application
• make build - Build and install to the ~/bin directory
• make test - Execute unit tests
• make fmt - Format the code using gofumpt
• make lint - Perform golangci-lint checks
• make inspect - Run in the MCP checker
• make help - Display help information

Development Guide

Project Structure

.
├── godevmcp/       # Application entry point
│   └── main.go     # Main application entry file
├── doc/            # Documentation files
├── internal/       # Private code libraries and library code
│   ├── app/        # Core application functionality code
│   ├── infra/      # Infrastructure code
│   ├── mcptool/    # MCP tool implementation
│   ├── repository/ # Repository implementation
│   └── subcmd/     # Subcommand implementation
├── output/         # Build artifacts
│   └── godevmcp    # Compiled executable file
├── pkg/            # Public library code
│   └── htmlu/      # HTML utility package
├── Makefile        # Build automation script
├── go.mod          # Go module definition
└── go.sum          # Go module checksum

Common Development Workflow

1. Modify the code.
2. Run make fmt to format the code.
3. Run make lint to check for code issues.
4. Run make test to execute unit tests.
5. Commit the changes.

Development Notes

• Please ensure that you have installed the latest versions of Go and the GitHub CLI tool.
• When using it in VSCode, please correctly configure the GOPATH environment variable.
• If you encounter problems, you can run make help to view all available commands.

With these tools and guides, you can perform Go development work more efficiently.