Godoc MCP Server

1# godoc-mcp-server
2 
3search golang packages and their docs from pkg.go.dev, provide the infomation to llm as mcp server
4 
5## Install
6 
7You can download the compiled binary from the [releases page](https://github.com/yikakia/godoc-mcp-server/releases/tag/latest).
8 
9Or you can install it from source, compile it by yourself:
10 
11```shell
12go install github.com/yikakia/godoc-mcp-server/cmd/godoc-mcp-server@latest
13```
14 
15## Usage
16 
17just use your client to request. it servers on stdio
18 
19## Todo
20 
21- localCache
22  - [x] use a local cache to avoid search every time(From reddit user)
23- searchPackage
24  - [x] imported by how many packages
25- getPackageInfo
26  - [ ] get examples
27- release
28  - [x] use github actions to release for multiple platforms 
29 
30## Develop Experience
31The description is very important, when describing the param should tell the client how 
32to use one tool's output and change the format to match another tool's input.
33 
34For example, the output of `searchPackage` contains subpackage's name, but do not contain
35the package's name. So if want the llm to use `getPackageInfo` to get the subpackage's info,
36I wrote the description for param `packageName` about how to use it to work with `searchPackage`:
37 
38> package name for search. if use searchPackages before, and user want to get the 
39subpackage info. you should plus them for example, when user query mcp, and it return 
40packageName: github.com/mark3labs/mcp-go/mcp and subpackage client, then if user want 
41to get the client package info, you should set the packageName to 
42github.com/mark3labs/mcp-go/mcp/client rather than client
43 
44 
45When using this detail description, the llm will tell you some subpackage's name after 
46search. You can just tell it which package you want to get info, or which package and the 
47subpackage's name, it will combine them and call `getPackageInfo` to get the info.
48 
49 
50So maybe we should make the description configurable by user, to make the tool more useful
51and efficiency.
52 
53## Library Usage
54 
55The exported Go API of this module should currently be considered unstable, and subject to 
56breaking changes. In the future, we may offer stability; please file an issue if there is 
57a use case where this would be valuable.
58 
59 
60## License
61 
62This project is licensed under the terms of the MIT open source license. Please refer 
63to [MIT](./LICENSE) for the full terms.
64