JinDaGe - go-dev-mcp MCP Details

article

README

🚀 GoDevMCP 开发工具

GoDevMCP 为 Go 开发提供了便捷工具，还集成了模型上下文协议（Model Context Protocol，MCP）功能，能极大提升 Go 开发的效率。

🚀 快速开始

GoDevMCP 为开发者提供了便捷的 Go 开发体验，集成了 MCP 功能，让开发更加高效。下面将为你详细介绍其安装与使用方法。

📦 安装指南

先决条件

需要安装 GitHub gh 命令行工具。

使用 go install 安装

可以直接使用 Go 的安装命令进行安装：

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

这将下载、编译并安装二进制文件到你的 $GOPATH/bin 目录（通常为 ~/go/bin）。请确保该目录已添加到系统 PATH 环境变量中。

从源码构建

克隆仓库
运行 make build 构建应用，运行 make install 安装。

VSCode 配置

在用户的 settings.json 中添加以下内容：

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

✨ 主要特性

工具集

run_make

执行常见的开发任务命令。

tree_dir

返回项目目录的树结构，方便导航查看。

search_godoc

在 pkg.go.dev 上搜索 Go 包，并返回匹配结果。 使用方法：

search_godoc query

示例：

search_godoc html

这将搜索与 "html" 相关的包，并返回匹配的包及其描述信息。

read_godoc

获取并显示特定 Go 包的文档。 使用方法：

read_godoc package_url

示例：

read_godoc golang.org/x/net/html

这将获取指定包的文档，包括描述、函数、类型和示例内容。

💻 使用示例

构建应用

make build

运行应用

make run

📚 详细文档

可用 Make 命令

make run - 运行应用
make build - 构建并安装到 ~/bin 目录
make test - 执行单元测试
make fmt - 使用 gofumpt 格式化代码
make lint - 执行 golangci-lint 检查
make inspect - 在 MCP 检查器中运行
make help - 显示帮助信息

开发指南

项目结构

.
├── godevmcp/       # 应用入口
│   └── main.go     # 主应用入口文件
├── doc/            # 文档文件
├── internal/       # 私有代码库和库代码
│   ├── app/        # 应用核心功能代码
│   ├── infra/      # 基础设施代码
│   ├── mcptool/    # MCP 工具实现
│   ├── repository/ # 仓库实现
│   └── subcmd/     # 子命令实现
├── output/         # 构建产物
│   └── godevmcp    # 编译生成的可执行文件
├── pkg/            # 公共库代码
│   └── htmlu/      # HTML 工具包
├── Makefile        # 构建自动化脚本
├── go.mod          # Go 模块定义
├── go.sum          # Go 模块校验和

常见开发工作流

修改代码
运行 make fmt 格式化代码
运行 make lint 检查代码问题
运行 make test 执行单元测试
提交更改

开发注意事项

请确保安装了最新版本的 Go 和 GitHub CLI 工具。
在 VSCode 中使用时，请正确配置 GOPATH 环境变量。
遇到问题时，可以运行 make help 查看所有可用命令。

通过这些工具和指南，您可以更高效地进行 Go 开发工作。

go-dev-mcp