371a06403a
Net **-650 LOC** by removing duplication and dead noise. All tests pass.
### Duplication & helpers
- Extracted shared slim helpers (`UserLogin`, `UserLogins`, `LabelNames`, `BodyWithAttachments`, `UserDetail`, `Repo`/`Repos`, `Label`/`Labels`) into `pkg/slim`. Deleted the 4 copies that lived in `issue/`, `pull/`, `search/`, `repo/` (plus duplicate `slimUserDetail`/`slimRepo`/`slimLabels` across packages).
- Added `params.GetOptionalBoolPtr` and `params.GetOptionalStringPtr`. Replaced 18 awkward `new(localVar); if !ok { = nil }` patterns across `repo/`, `pull/`, `issue/`, `label/`, `milestone/`, `search/`.
- Extracted `pullRequestReviewerFn` for the 99%-identical `createPullRequestReviewerFn`/`deletePullRequestReviewerFn` pair.
### Dead code & noise
- Deleted **122** `log.Debugf("Called X")` narration lines (`zap.AddCaller` already records the caller) and pruned 19 unused `log` imports.
- Removed the unused `log.Logger` wrapper; the mcp-go server now uses `log.Default().Sugar()` directly (matches `util.Logger`).
- Deleted dead `s.DeleteTools("")` — confirmed no-op in mcp-go.
- Stripped WHAT-narration comments per project guidance.
### Correctness & consistency
- Fixed `log.Errorf(err.Error())` format-string bug in `pkg/to/to.go` — a `%` in the error would have been interpreted as a directive.
- Standardized `to.TextResult`/`to.ErrorResult` usage; `release.go`, `tag.go`, `branch.go` were bypassing the helpers in 9 sites (skipping the wrapper's debug/error logging).
- Made `params.GetString` reject empty strings; dropped 21 redundant `err != nil || x == ""` checks in `operation/actions/`.
- Replaced raw `args["org"].(string)` in `ListOrgReposFn` with `params.GetString` to match the rest of the codebase.
### Performance
- **Cached `*gitea.Client` by host+token via `sync.Map`** + shared `*http.Transport` via `sync.Once` for both SDK and raw REST paths. Eliminates the SDK's `/api/v1/version` preflight on every tool call and enables connection keep-alive across requests.
- Gated `to.TextResult` debug log behind `flag.Debug` to skip the `string(bytes)` allocation when debug is off.
- Hoisted `8192` and `60s` magic numbers in `pkg/gitea/rest.go` into named constants.
---
This PR was written with the help of Claude Opus 4.7
---------
Co-authored-by: silverwind <silv3rwind@gmail.com>
Reviewed-on: https://gitea.com/gitea/gitea-mcp/pulls/195
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: silverwind <me@silverwind.io>
Co-committed-by: silverwind <me@silverwind.io>
270 lines
7.9 KiB
Go
270 lines
7.9 KiB
Go
package wiki
|
|
|
|
import (
|
|
"context"
|
|
"encoding/base64"
|
|
"fmt"
|
|
"net/url"
|
|
|
|
"gitea.com/gitea/gitea-mcp/pkg/annotation"
|
|
"gitea.com/gitea/gitea-mcp/pkg/gitea"
|
|
"gitea.com/gitea/gitea-mcp/pkg/params"
|
|
"gitea.com/gitea/gitea-mcp/pkg/to"
|
|
"gitea.com/gitea/gitea-mcp/pkg/tool"
|
|
|
|
"github.com/mark3labs/mcp-go/mcp"
|
|
"github.com/mark3labs/mcp-go/server"
|
|
)
|
|
|
|
var Tool = tool.New()
|
|
|
|
const (
|
|
WikiReadToolName = "wiki_read"
|
|
WikiWriteToolName = "wiki_write"
|
|
)
|
|
|
|
var (
|
|
WikiReadTool = mcp.NewTool(
|
|
WikiReadToolName,
|
|
mcp.WithDescription("Read wiki: list pages, get content, revision history."),
|
|
mcp.WithToolAnnotation(annotation.ReadOnly("Read wiki pages")),
|
|
mcp.WithString("method", mcp.Required(), mcp.Enum("list", "get", "get_revisions")),
|
|
mcp.WithString("owner", mcp.Required(), mcp.Description(params.OwnerDesc)),
|
|
mcp.WithString("repo", mcp.Required(), mcp.Description(params.RepoDesc)),
|
|
mcp.WithString("pageName", mcp.Description("for 'get'/'get_revisions'")),
|
|
)
|
|
|
|
WikiWriteTool = mcp.NewTool(
|
|
WikiWriteToolName,
|
|
mcp.WithDescription("Write wiki pages: create, update, delete."),
|
|
mcp.WithToolAnnotation(annotation.Destructive("Create, update, or delete wiki pages")),
|
|
mcp.WithString("method", mcp.Required(), mcp.Enum("create", "update", "delete")),
|
|
mcp.WithString("owner", mcp.Required(), mcp.Description(params.OwnerDesc)),
|
|
mcp.WithString("repo", mcp.Required(), mcp.Description(params.RepoDesc)),
|
|
mcp.WithString("pageName", mcp.Description("for 'update'/'delete'")),
|
|
mcp.WithString("title", mcp.Description("for 'create'")),
|
|
mcp.WithString("content", mcp.Description("for 'create'/'update'")),
|
|
mcp.WithString("message", mcp.Description("commit message")),
|
|
)
|
|
)
|
|
|
|
func init() {
|
|
Tool.RegisterRead(server.ServerTool{
|
|
Tool: WikiReadTool,
|
|
Handler: wikiReadFn,
|
|
})
|
|
Tool.RegisterWrite(server.ServerTool{
|
|
Tool: WikiWriteTool,
|
|
Handler: wikiWriteFn,
|
|
})
|
|
}
|
|
|
|
func wikiReadFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
|
method, err := params.GetString(req.GetArguments(), "method")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
switch method {
|
|
case "list":
|
|
return listWikiPagesFn(ctx, req)
|
|
case "get":
|
|
return getWikiPageFn(ctx, req)
|
|
case "get_revisions":
|
|
return getWikiRevisionsFn(ctx, req)
|
|
default:
|
|
return to.ErrorResult(fmt.Errorf("unknown method: %s", method))
|
|
}
|
|
}
|
|
|
|
func wikiWriteFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
|
method, err := params.GetString(req.GetArguments(), "method")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
switch method {
|
|
case "create":
|
|
return createWikiPageFn(ctx, req)
|
|
case "update":
|
|
return updateWikiPageFn(ctx, req)
|
|
case "delete":
|
|
return deleteWikiPageFn(ctx, req)
|
|
default:
|
|
return to.ErrorResult(fmt.Errorf("unknown method: %s", method))
|
|
}
|
|
}
|
|
|
|
func listWikiPagesFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
|
args := req.GetArguments()
|
|
owner, err := params.GetString(args, "owner")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
repo, err := params.GetString(args, "repo")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
|
|
var result any
|
|
_, err = gitea.DoJSON(ctx, "GET", fmt.Sprintf("repos/%s/%s/wiki/pages", url.PathEscape(owner), url.PathEscape(repo)), nil, nil, &result)
|
|
if err != nil {
|
|
return to.ErrorResult(fmt.Errorf("list wiki pages err: %v", err))
|
|
}
|
|
|
|
return to.TextResult(result)
|
|
}
|
|
|
|
func getWikiPageFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
|
args := req.GetArguments()
|
|
owner, err := params.GetString(args, "owner")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
repo, err := params.GetString(args, "repo")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
pageName, err := params.GetString(args, "pageName")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
|
|
var result any
|
|
_, err = gitea.DoJSON(ctx, "GET", fmt.Sprintf("repos/%s/%s/wiki/page/%s", url.PathEscape(owner), url.PathEscape(repo), url.PathEscape(pageName)), nil, nil, &result)
|
|
if err != nil {
|
|
return to.ErrorResult(fmt.Errorf("get wiki page err: %v", err))
|
|
}
|
|
|
|
return to.TextResult(result)
|
|
}
|
|
|
|
func getWikiRevisionsFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
|
args := req.GetArguments()
|
|
owner, err := params.GetString(args, "owner")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
repo, err := params.GetString(args, "repo")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
pageName, err := params.GetString(args, "pageName")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
|
|
var result any
|
|
_, err = gitea.DoJSON(ctx, "GET", fmt.Sprintf("repos/%s/%s/wiki/revisions/%s", url.PathEscape(owner), url.PathEscape(repo), url.PathEscape(pageName)), nil, nil, &result)
|
|
if err != nil {
|
|
return to.ErrorResult(fmt.Errorf("get wiki revisions err: %v", err))
|
|
}
|
|
|
|
return to.TextResult(result)
|
|
}
|
|
|
|
func createWikiPageFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
|
args := req.GetArguments()
|
|
owner, err := params.GetString(args, "owner")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
repo, err := params.GetString(args, "repo")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
title, err := params.GetString(args, "title")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
content, err := params.GetString(args, "content")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
|
|
message, _ := args["message"].(string)
|
|
if message == "" {
|
|
message = fmt.Sprintf("Create wiki page '%s'", title)
|
|
}
|
|
|
|
requestBody := map[string]string{
|
|
"title": title,
|
|
"content_base64": base64.StdEncoding.EncodeToString([]byte(content)),
|
|
"message": message,
|
|
}
|
|
|
|
var result any
|
|
_, err = gitea.DoJSON(ctx, "POST", fmt.Sprintf("repos/%s/%s/wiki/new", url.PathEscape(owner), url.PathEscape(repo)), nil, requestBody, &result)
|
|
if err != nil {
|
|
return to.ErrorResult(fmt.Errorf("create wiki page err: %v", err))
|
|
}
|
|
|
|
return to.TextResult(result)
|
|
}
|
|
|
|
func updateWikiPageFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
|
args := req.GetArguments()
|
|
owner, err := params.GetString(args, "owner")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
repo, err := params.GetString(args, "repo")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
pageName, err := params.GetString(args, "pageName")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
content, err := params.GetString(args, "content")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
|
|
requestBody := map[string]string{
|
|
"content_base64": base64.StdEncoding.EncodeToString([]byte(content)),
|
|
}
|
|
|
|
// If title is given, use it. Otherwise, keep current page name
|
|
if title, ok := args["title"].(string); ok && title != "" {
|
|
requestBody["title"] = title
|
|
} else {
|
|
requestBody["title"] = pageName
|
|
}
|
|
|
|
if message, ok := args["message"].(string); ok && message != "" {
|
|
requestBody["message"] = message
|
|
} else {
|
|
requestBody["message"] = fmt.Sprintf("Update wiki page '%s'", pageName)
|
|
}
|
|
|
|
var result any
|
|
_, err = gitea.DoJSON(ctx, "PATCH", fmt.Sprintf("repos/%s/%s/wiki/page/%s", url.PathEscape(owner), url.PathEscape(repo), url.PathEscape(pageName)), nil, requestBody, &result)
|
|
if err != nil {
|
|
return to.ErrorResult(fmt.Errorf("update wiki page err: %v", err))
|
|
}
|
|
|
|
return to.TextResult(result)
|
|
}
|
|
|
|
func deleteWikiPageFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
|
args := req.GetArguments()
|
|
owner, err := params.GetString(args, "owner")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
repo, err := params.GetString(args, "repo")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
pageName, err := params.GetString(args, "pageName")
|
|
if err != nil {
|
|
return to.ErrorResult(err)
|
|
}
|
|
|
|
_, err = gitea.DoJSON(ctx, "DELETE", fmt.Sprintf("repos/%s/%s/wiki/page/%s", url.PathEscape(owner), url.PathEscape(repo), url.PathEscape(pageName)), nil, nil, nil)
|
|
if err != nil {
|
|
return to.ErrorResult(fmt.Errorf("delete wiki page err: %v", err))
|
|
}
|
|
|
|
return to.TextResult(map[string]string{"message": "Wiki page deleted successfully"})
|
|
}
|