关键词

Go开发工具代码导航文档查询GitHub集成构建自动化

GoDevMCP 使用说明

项目简介

GoDevMCP 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 Go 语言开发提供便捷的工具集。它通过 MCP 协议与客户端（如支持 MCP 的编辑器或 IDE 插件）通信，提供了一系列实用的工具，帮助开发者更高效地进行 Go 项目开发。

主要功能点

  • run_make: 执行 'make' 命令，方便进行常见的 Go 项目构建、测试和代码检查等任务。
  • tree_dir: 以树状结构展示项目目录，方便快速了解和导航项目文件结构。
  • search_godoc: 在 pkg.go.dev 上搜索 Go 语言包文档，快速查找需要的包和信息。
  • read_godoc: 读取并显示指定 Go 语言包的详细文档，方便学习和参考 Go 标准库和第三方库。
  • search_github_code: 在 GitHub 上搜索代码，辅助开发者查找示例代码或特定功能的实现方式。
  • get_github_content: 获取 GitHub 仓库中指定文件的内容，方便查看和复制代码片段。
  • tree_github_repo: 以树状结构展示 GitHub 仓库的目录结构，方便了解远程仓库的文件组织。

安装步骤

  1. 安装 Prerequisites: 确保已安装 GitHub 命令行工具 'gh'。

  2. 使用 'go install' 安装 (推荐): 打开终端，运行以下命令安装 GoDevMCP：

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

    安装完成后，确保 '~/go/bin' 目录已添加到系统的 PATH 环境变量中。

  3. 从源码构建:

    • 克隆仓库到本地： 
      git clone https://github.com/fpt/go-dev-mcp.git
cd go-dev-mcp
    • 构建并安装： 
      make build
make install

服务器配置 (用于 MCP 客户端)

以下是在 VSCode 中配置 GoDevMCP 服务器的 JSON 格式示例。其他 MCP 客户端的配置方式类似，关键在于配置服务器的启动命令和参数。

{
    "servers": {
        "go-dev-mcp": {
            "type": "stdio",
            "command": "godevmcp", // 服务器启动命令，通常是编译后的可执行文件名
            "args": [
                "serve" // 'serve' 子命令指示 godevmcp 启动 MCP 服务器
            ]
        }
    }
}

配置说明:

  • '"servers"': 定义 MCP 服务器配置的根节点。
  • '"go-dev-mcp"': 服务器名称，可以自定义，用于在客户端中标识该服务器。
  • '"type": "stdio"': 指定服务器使用标准输入输出 (stdio) 作为通信协议。
  • '"command": "godevmcp"': 指定启动 MCP 服务器的命令。这里假设 'godevmcp' 可执行文件已在系统 PATH 中。如果不在，需要提供可执行文件的完整路径。
  • '"args": ["serve"]': 传递给 'godevmcp' 命令的参数。'"serve"' 参数指示 'godevmcp' 启动 MCP 服务器模式。

基本使用方法

  1. 启动 MCP 服务器: 根据安装步骤完成 GoDevMCP 的安装。MCP 服务器将在 MCP 客户端连接时自动启动 (例如，在 VSCode 中配置并激活 MCP 扩展后)。

  2. 在 MCP 客户端中使用工具: 连接到 GoDevMCP 服务器后，您可以在 MCP 客户端中调用 GoDevMCP 提供的工具。工具名称和参数定义在 'internal/mcptool/register.go' 文件中。

    例如，在支持 MCP 的编辑器或 IDE 中，您可以调用 'run_make' 工具来执行 'make' 命令，或者使用 'tree_dir' 工具查看当前项目目录结构。 具体工具的使用方法请参考仓库 README.md 文件中 "Tools" 部分的说明。

信息

分类

开发者工具

访问项目