Toggle navigation
Product
Explore
Solutions
By company size
By use case
By industry
Resources
Topics
Explore
Open Source
Repositories
Enterprise
Available add-ons
Search or jump to…
Search
Clear
We read every piece of feedback, and take your input very seriously.
Include my email address so I can be contacted
Cancel Submit feedback
Name
Query
To see all available qualifiers, see our documentation.
Cancel Create saved search
Sign up Reseting focus
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
{{ message }}
go doc mcp server
17 stars 1 fork Branches Tags Activity
Notifications You must be signed in to change notification settings
Additional navigation options
main
Go to file
Code
| Name | Name | Last commit message
|
Last commit date
| | — | — | — | — | |
Jan 16, 2025
354d90b · Jan 16, 2025
| |
|
|
|
Dec 5, 2024
| |
|
|
|
Dec 5, 2024
| |
|
|
|
Jan 9, 2025
| |
|
|
|
Dec 5, 2024
| |
|
|
|
Dec 5, 2024
| |
|
|
|
Jan 16, 2025
| |
View all files
|
godoc-mcp
is a Model Context Protocol (MCP) server that provides efficient access to Go documentation. It helps LLMs understand Go projects by providing direct access to package documentation without needing to read entire source files. godoc-mcp
can vastly improve the performance of using LLMs to develop in Go by substantially reducing the number of tokens needed to understand and make use of Go packages.
go install github.com/mrjoshuak/godoc-mcp@latest
In a sentence: godoc-mcp
provides a more token efficient way for LLMs to understand Go projects.
Traditional file-reading approaches require LLMs to process entire source files often many files to understand a single package. godoc-mcp
provides several advantages:
godoc-mcp
a fast and efficient tool for Go developmentWith godoc-mcp
, a LLM can get precisely the information it needs without having to read entire source files. Here are the different levels of detail that an LLM can get.
This makes godoc-mcp
an essential tool for Go developers using LLMs by enabling LLMs to understand significantly more, and in more detail, about the context than previously possible in any programming language.
The server will:
go doc
from the working directory)In addition to providing documentation while working on coding tasks. godoc-mcp
can also be used to explore Go projects and packages. Here are some examples for general prompting:
“I’m looking at a Go project at /path/to/some/project. What packages does it contain and what do they do?”
“What interfaces does the io package provide? I’m particularly interested in anything related to reading.”
“I need to implement the io.Reader interface. Show me its documentation and any related types I should know about.”
“Show me the documentation for the Resource type in the /path/to/some/project. I need to understand how to create and use it.”
“I’m in /path/to/some/project which uses github.com/gorilla/mux. Show me the documentation for the Router type.”
“What methods are available on the http.Request type? I’m working with standard library HTTP handlers.”
“Explain how to configure the Server type in the /path/to/project/server package.”
“I’m in a new Go project directory and see multiple packages. Can you show me what each one does?”
To add to the Claude desktop app:
{
"mcpServers": {
# other MCP servers ...
"godoc": {
"command": "/path/to/godoc-mcp",
"args": [],
"env": {
"GOPATH": "/path/to/go",
"GOMODCACHE": "/path/to/go/pkg/mod"
}
}
}
}
When connected to an MCP-capable LLM (like Claude), godoc-mcp provides the get_doc
tool with the following parameters:
path
: Path to the Go package or file (import path or file path)target
(optional): Specific symbol to document (function, type, etc.)cmd_flags
(optional): Additional go doc command flagsworking_dir
(optional): Working directory for module-aware documentation (if not provided, a temporary project will be created automatically)Advanced cmd_flags
values that an LLM can leverage:
-all
: Show all documentation for package, excluding unexported symbols-u
: Show unexported symbols-src
: Show the source code instead of documentationThis project is licensed under the MIT License - see the LICENSE file for details.
go doc mcp server
No releases published
You can’t perform that action at this time.
An MCP server enhances AI responses with real-time search results via Higress ai-search.
MCP server for creating UI flowcharts
A Model Context Protocol (MCP) server that provides tools for interacting with the Twitch API using the Helix API.
MCP Server to run python code locally