godoc-mcp-server

by yikakia

Development/Documentation go golang documentation package

This server searches Go packages and their documentation from pkg.go.dev and provides the information to a language model (LLM) as an MCP (Machine Comprehension Pipeline) server. It allows LLMs to access and utilize Go package documentation for various tasks.

View on GitHub

Last updated: N/A

What is godoc-mcp-server?

godoc-mcp-server is a server that retrieves Go package information from pkg.go.dev and presents it in a format suitable for consumption by Language Models (LLMs) acting as an MCP server.

How to use godoc-mcp-server?

The server is intended to be used by a client that sends requests to it via stdio. The client can search for packages and retrieve detailed information about them, which can then be used by an LLM for tasks such as code generation, documentation, or understanding Go code.

Key features of godoc-mcp-server

Searches Go packages and documentation from pkg.go.dev
Provides package information to LLMs
Acts as an MCP server
Includes a local cache to avoid redundant searches
Provides information on how many packages import a given package

Use cases of godoc-mcp-server

Enabling LLMs to generate Go code
Providing LLMs with context for understanding Go code
Allowing LLMs to answer questions about Go packages and their usage
Assisting LLMs in writing documentation for Go packages

FAQ from godoc-mcp-server

What is the purpose of this server?

To provide Go package documentation to LLMs in a structured format.

How do I install the server?

You can download the compiled binary from the releases page or install it from source using go install.

How do I use the server?

Use your client to send requests to the server via stdio.

Is the Go API stable?

No, the exported Go API is currently considered unstable and subject to breaking changes.

Where can I find the license?

The project is licensed under the MIT open source license. Please refer to the MIT file for the full terms.