search support imported By

Author: yikakia

README.md

@@ -18,18 +18,46 @@ just use your client to request. it servers on stdio
 
 ## Todo
 
+- localCache
+  - [ ] use a local cache to avoid search every time(From reddit user)
 - searchPackage
-  - [ ] imported by how many packages
+  - [x] imported by how many packages
 - getPackageInfo
   - [ ] get examples
 - release
   - [x] use github actions to release for multiple platforms 
 
+## Develop Experience
+The description is very important, when describing the param should tell the client how 
+to use one tool's output and change the format to match another tool's input.
+
+For example, the output of `searchPackage` contains subpackage's name, but do not contain
+the package's name. So if want the llm to use `getPackageInfo` to get the subpackage's info,
+I wrote the description for param `packageName` about how to use it to work with `searchPackage`:
+
+> package name for search. if use searchPackages before, and user want to get the 
+subpackage info. you should plus them for example, when user query mcp, and it return 
+packageName: github.com/mark3labs/mcp-go/mcp and subpackage client, then if user want 
+to get the client package info, you should set the packageName to 
+github.com/mark3labs/mcp-go/mcp/client rather than client
+
+
+When using this detail description, the llm will tell you some subpackage's name after 
+search. You can just tell it which package you want to get info, or which package and the 
+subpackage's name, it will combine them and call `getPackageInfo` to get the info.
+
+
+So maybe we should make the description configurable by user, to make the tool more useful
+and efficiency.
+
 ## Library Usage
 
-The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.
+The exported Go API of this module should currently be considered unstable, and subject to 
+breaking changes. In the future, we may offer stability; please file an issue if there is 
+a use case where this would be valuable.
 
 
 ## License
 
-This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
+This project is licensed under the terms of the MIT open source license. Please refer 
+to [MIT](./LICENSE) for the full terms.

cmd/godoc-mcp-server/search.go

@@ -12,7 +12,8 @@ import (
 
 func getSearchTool() (tool mcp.Tool, handler server.ToolHandlerFunc) {
 	return mcp.NewTool("searchPackages",
-			mcp.WithDescription("provide a query, search related golang packages from pkg.go.dev"),
+			mcp.WithDescription("provide a query, search related golang packages from pkg.go.dev include "+
+				"name, path, synopsis, go doc url, imported by how many packages, subpackages in this package"),
 			mcp.WithString("q",
 				mcp.Required(),
 				mcp.Description("query")),

pkg/godoc/search.go

@@ -1,6 +1,7 @@
 package godoc
 
 import (
+	"strconv"
 	"strings"
 
 	"github.com/PuerkitoBio/goquery"
@@ -14,11 +15,12 @@ type SearchResult struct {
 }
 
 type SearchPackageInfo struct {
-	Name          string
-	Path          string
-	Synopsis      string
-	GoDocUrl      string
-	OtherPackages []string `json:"other_packages_in_this_module,omitempty"`
+	Name        string
+	Path        string
+	Synopsis    string
+	GoDocUrl    string
+	ImportedBy  int
+	SubPackages []string `json:"sub_packages,omitempty"`
 }
 
 func Search(query string) (*SearchResult, error) {
@@ -75,17 +77,23 @@ func extractPackageInfo(selection *goquery.Selection) (*SearchPackageInfo, error
 	if err != nil {
 		return nil, err
 	}
+	imptBy, err := extractImportedBy(selection)
+	if err != nil {
+		return nil, err
+	}
+
 	otherPackages, err := extractOtherPackages(selection)
 	if err != nil {
 		return nil, err
 	}
 
 	return &SearchPackageInfo{
-		Name:          name,
-		Path:          path,
-		Synopsis:      synopsis,
-		GoDocUrl:      baseURL() + url,
-		OtherPackages: otherPackages,
+		Name:        name,
+		Path:        path,
+		Synopsis:    synopsis,
+		GoDocUrl:    baseURL() + url,
+		SubPackages: otherPackages,
+		ImportedBy:  imptBy,
 	}, nil
 }
 
@@ -119,6 +127,17 @@ func extractPackageSynopsis(selection *goquery.Selection) (string, error) {
 	return synopsis, nil
 }
 
+func extractImportedBy(selection *goquery.Selection) (int, error) {
+
+	im := selection.
+		Find("div.SearchSnippet-infoLabel").
+		Find("a[aria-label='Go to Imported By']").
+		Find("strong").Text()
+
+	atoi, _ := strconv.Atoi(im)
+	return atoi, nil
+}
+
 func extractPackageGoDocUrl(selection *goquery.Selection) (string, error) {
 	var goDocUrl string