godoc-mcp-server

godoc-mcp-server

site icon
2025.04.10 14
GoGo 语言开发文档搜索开发效率
godoc-mcp-server 是一个用于搜索 Go 语言包及其文档的服务,从 pkg.go.dev 获取信息并提供给 LLM 作为 MCP 服务器。它支持本地缓存、搜索包的导入次数、获取包信息等功能,旨在提升开发效率。
View on GitHub

Overview

基本能力

产品定位

godoc-mcp-server 是一个为 Go 语言开发者提供的工具,用于快速搜索和获取 Go 包的文档信息,并通过 MCP 服务器将这些信息提供给 LLM(大型语言模型)。

核心功能

  1. 搜索 Go 包:从 pkg.go.dev 搜索 Go 包及其文档。
  2. 本地缓存:使用本地缓存避免重复搜索。
  3. 获取包信息:支持获取包的详细信息,包括子包信息。
  4. 多平台发布:通过 GitHub Actions 支持多平台发布。

适用场景

  1. 开发工具集成:集成到开发工具中,快速获取 Go 包文档。
  2. LLM 辅助开发:为 LLM 提供 Go 包信息,辅助代码生成或文档查询。
  3. 团队协作:帮助团队成员快速了解依赖包的使用方式。

工具列表

  1. searchPackage:搜索 Go 包及其子包信息。
  2. getPackageInfo:获取指定包的详细信息。

常见问题解答

  1. 如何获取子包信息?:在调用 getPackageInfo 时,需要将父包名和子包名拼接作为参数(例如 github.com/mark3labs/mcp-go/mcp/client)。
  2. 是否支持本地缓存?:是的,支持本地缓存以避免重复搜索。

使用教程

使用依赖

  1. 确保已安装 Go 环境(1.16+)。

安装教程

  1. 从源码安装shell go install github.com/yikakia/godoc-mcp-server/cmd/godoc-mcp-server@latest
  2. 从发布页面下载: 从 releases page 下载预编译的二进制文件。

调试方式

  1. 启动服务后,通过客户端请求服务接口。
  2. 服务默认通过 stdio 提供接口。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。