go-mcp

基本能力

产品定位

go-mcp 是一个为 AI 助手提供 Go 文档和包列表功能的工具，旨在帮助 AI 系统更好地理解和处理 Go 代码。

核心功能

• Go 文档访问：使用 go doc 命令查询 Go 包、类型、函数或方法的文档。
• 包列表：使用 go list 命令列出 Go 模块中的可用包。

适用场景

• AI 助手需要查询 Go 代码的文档时。
• 开发者在 AI 辅助下需要快速了解 Go 代码库的结构和功能时。

工具列表

• go_doc：获取 Go 包、类型、函数或方法的文档。
• 参数：
  • pkgSymMethodOrField：要查询文档的包、符号、方法或字段。
  • cmd_flags：（可选）额外的命令标志，如 -all、-src 或 -u。
• go_list：列出 Go 包或模块。
• 参数：
  • packages：要列出的包模式数组（例如 ["./...", "github.com/user/repo/..."]）。
  • cmd_flags：（可选）额外的命令标志，如 -json。

常见问题解答

1. 如何安装 go-mcp？
2. 使用 go install github.com/wricardo/go-mcp@latest 命令安装。
3. 如何配置 go-mcp？
4. 在 MCP 设置中添加相应的配置，指定工作目录等参数。
5. 如何使用 go_doc 和 go_list？
6. 参考示例中的 JSON 请求格式，指定相应的参数和标志。

使用教程

使用依赖

• Go 1.16 或更高版本。
• 配置了 GOPATH 的工作 Go 环境。
• 需要访问要文档化的包。

安装教程

1. 安装包： bash go install github.com/wricardo/go-mcp@latest
2. 配置 MCP 兼容的助手，在 MCP 设置中添加以下内容： json "go-mcp": { "command": "go-mcp", "env": { "WORKDIR": "/path/to/your/go/project" }, "disabled": false, "autoApprove": [] }

调试方式

1. 确保 Go 环境配置正确。
2. 确保工作目录路径正确。
3. 使用示例中的 JSON 请求测试 go_doc 和 go_list 功能。

最佳实践

1. 在直接检查源代码之前，始终先尝试使用 go_doc。
2. 在查看特定符号之前，先从基本包文档开始。
3. 使用 -all 标志获取全面的包文档。
4. 使用 -u 标志查看未导出的符号。
5. 当文档不足时，使用 -src 标志查看源代码。

许可证

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