Godoc MCP Server

🚀 godoc-mcp-server

Search for Go language packages and their documentation on pkg.go.dev and provide the information to the LLM as an MCP server.

🚀 Quick Start

This server searches for Go language packages and their documentation on pkg.go.dev and provides the information to the LLM.

✨ Features

• Utilize local cache to avoid repeated searches.
• Provide information on how many packages a particular package is imported by.
• Plan to obtain package usage examples.
• Automatically release for multiple platforms using GitHub Actions.

📦 Installation

You can download the pre - compiled binary from the release page.

Alternatively, you can install from the source code and compile it yourself:

go install github.com/yikakia/godoc-mcp-server/cmd/godoc-mcp-server@latest

💻 Usage Examples

Basic Usage

Simply make requests using your client. It operates on standard input and output.

📚 Documentation

To - Do List

• localCache
  • [x] Use local cache to avoid repeated searches (suggested by Reddit users).
• searchPackage
  • [x] Determine how many packages a particular package is imported by.
• getPackageInfo
  • [ ] Obtain usage examples.
• Release
  • [x] Use GitHub Actions to release for multiple platforms.

Development Experience

Descriptions are crucial. When describing parameters, you should inform the client how to use the output of one tool to modify the input format of another tool.

For example, the output of searchPackage includes the names of sub - packages but not the package name. Therefore, if you want the LLM to use getPackageInfo to obtain information about a sub - package, I wrote the following description for the packageName parameter:

The name of the package to search for. If you have previously used searchPackages and the user wishes to obtain information about a sub - package, you should combine them. For example, when the user queries mcp, it returns packageName: github.com/mark3labs/mcp - go/mcp and a sub - package client. Then, if the user wishes to obtain information about the client, you should set packageName to github.com/mark3labs/mcp - go/mcp/client instead of client.

If you use this detailed description, the LLM will tell you the names of some sub - packages. You can directly tell it which package's information to obtain, or which package and its sub - packages' information to obtain, and then it will combine them and call getPackageInfo to retrieve the information.

Therefore, perhaps we should allow users to configure this description to make the tool more useful and efficient.

Library Usage

The Go API exported by this module should currently be considered unstable and may have breaking changes. We may provide stability in the future; please submit issues to feedback your use cases.

📄 License

This project is licensed under the MIT open - source license. See MIT for the full terms.