Go Documentation

🚀 godoc-mcp

godoc-mcp is a Model Context Protocol (MCP) server that provides efficient access to Go documentation, helping LLMs understand Go projects without reading the entire source files.

🚀 Quick Start

To get started with godoc-mcp, you can install it using the following command:

go install github.com/mrjoshuak/godoc-mcp@latest

✨ Features

Core Features

• Automatic Module Context Handling: The server automatically creates temporary projects to resolve external packages, eliminating the need for manual GOPATH and GOMODCACHE configuration.
• Flexible Documentation Retrieval:
  • Retrieve full package documentation.
  • View detailed information about specific symbols (functions, types, etc.).
  • Optionally display unexported symbols.
  • Optionally display source code.

Advanced Features

• Support for Multiple Working Directories: Multiple projects can be handled by configuring different GOPATH and GOMODCACHE settings.
• Efficient Tokenization Strategy: Unnecessary documentation loading is reduced through optimized command-line parameters.

📦 Why Choose godoc-mcp?

In a nutshell, godoc-mcp provides access to Go documentation in a more efficient tokenization manner.

By directly retrieving package documentation, LLMs can:

• Quickly understand the code structure.
• Precisely locate API usage methods.
• Acutely perceive design patterns.

💻 Usage Examples

Basic Usage

Add the following configuration in the Claude desktop application:

{
  "mcpServers": {
    # Other MCP servers ...
    "godoc": {
      "command": "/path/to/godoc-mcp",
      "args": [],
      "env": {
        "GOPATH": "/path/to/go",
        "GOMODCACHE": "/path/to/go/pkg/mod"
      }
    }
  }
}

When connecting to an MCP - supported LLM (such as Claude), godoc-mcp provides the get_doc tool, which supports the following parameters:

• Path: The path to a Go package or file (import path or file path).
• Target (optional): Specify the specific symbol (function, type, etc.) for which to retrieve documentation.
• Command-line arguments (optional): Additional go doc command parameters.
• Working directory (optional): A specific working directory for module - aware documentation retrieval (if not provided, a temporary project is created by default).

Common Command-line arguments include:

• -all: Display all documentation, excluding unexported symbols.
• -u: Display unexported symbols.
• -src: Display source code instead of documentation.

📚 Troubleshooting

• For local paths, ensure that they contain Go source files or point to directories containing Go packages.
• If module - related errors occur, correctly set the GOPATH and GOMODCACHE environment variables in the MCP server configuration.
• The server automatically handles the module context of external packages, but you can still provide a specific Working directory if you have special requirements.

📄 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.