Compare commits

..

1 Commits

Author SHA1 Message Date
Lunny Xiao b22ee74148 feat(params): add structured argument binding helper
Add params.Bind, which unmarshals a tool call's map[string]any args into a
typed struct via JSON round-trip so JSON numbers land in the correct Go
numeric field types, and enforces `required:"true"` struct tags with clear
errors. Migrate the branch, tree, and file repo handlers to use it instead
of repeated args["x"].(string)/!ok extraction, preserving existing
validation behavior for each field.

Co-Authored-By: Codet <codet@commitgo.dev> (GPT-5-Codex)
2026-08-24 00:14:34 -07:00
8 changed files with 289 additions and 466 deletions
+1 -6
View File
@@ -29,7 +29,7 @@ var (
ActionsRunReadToolName, ActionsRunReadToolName,
"Read Actions workflows, runs, jobs, logs, and artifacts.", "Read Actions workflows, runs, jobs, logs, and artifacts.",
annotation.ReadOnly("Read Actions workflow, run, job, and artifact data"), annotation.ReadOnly("Read Actions workflow, run, job, and artifact data"),
tool.String("method", tool.Required(), tool.Enum("list_workflows", "get_workflow", "list_runs", "get_run", "list_jobs", "list_run_jobs", "get_job", "get_job_log_preview", "download_job_log", "list_artifacts", "list_run_artifacts", "get_artifact", "download_artifact", "wait_for_pr_checks")), tool.String("method", tool.Required(), tool.Enum("list_workflows", "get_workflow", "list_runs", "get_run", "list_jobs", "list_run_jobs", "get_job", "get_job_log_preview", "download_job_log", "list_artifacts", "list_run_artifacts", "get_artifact", "download_artifact")),
tool.String("owner", tool.Required(), tool.Description(params.OwnerDesc)), tool.String("owner", tool.Required(), tool.Description(params.OwnerDesc)),
tool.String("repo", tool.Required(), tool.Description(params.RepoDesc)), tool.String("repo", tool.Required(), tool.Description(params.RepoDesc)),
tool.String("workflow_id", tool.Description("ID or filename (for 'get_workflow')")), tool.String("workflow_id", tool.Description("ID or filename (for 'get_workflow')")),
@@ -43,9 +43,6 @@ var (
tool.String("output_path", tool.Description("for 'download_job_log'/'download_artifact'")), tool.String("output_path", tool.Description("for 'download_job_log'/'download_artifact'")),
tool.Number("page", tool.Description(params.PageDesc), tool.Default(1), tool.Minimum(1)), tool.Number("page", tool.Description(params.PageDesc), tool.Default(1), tool.Minimum(1)),
tool.Number("per_page", tool.Description(params.PaginationDesc), tool.Default(30), tool.Minimum(1)), tool.Number("per_page", tool.Description(params.PaginationDesc), tool.Default(30), tool.Minimum(1)),
tool.Number("pull_number", tool.Description("PR number (for 'wait_for_pr_checks')")),
tool.Number("timeout_seconds", tool.Description("max time to wait (for 'wait_for_pr_checks')"), tool.Default(120), tool.Minimum(1)),
tool.Number("poll_interval_seconds", tool.Description("time between polls (for 'wait_for_pr_checks')"), tool.Default(5), tool.Minimum(1)),
) )
ActionsRunWriteTool = tool.NewDefinition( ActionsRunWriteTool = tool.NewDefinition(
@@ -99,8 +96,6 @@ func runReadFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, e
return getRepoActionArtifactFn(ctx, args) return getRepoActionArtifactFn(ctx, args)
case "download_artifact": case "download_artifact":
return downloadRepoActionArtifactFn(ctx, args) return downloadRepoActionArtifactFn(ctx, args)
case "wait_for_pr_checks":
return waitForPRChecksFn(ctx, args)
default: default:
return to.ErrorResult(fmt.Errorf("unknown method: %s", method)) return to.ErrorResult(fmt.Errorf("unknown method: %s", method))
} }
-174
View File
@@ -1,174 +0,0 @@
package actions
import (
"context"
"errors"
"fmt"
"net/url"
"strings"
"time"
"gitea.com/gitea/gitea-mcp/pkg/params"
"gitea.com/gitea/gitea-mcp/pkg/to"
"github.com/modelcontextprotocol/go-sdk/mcp"
)
const (
defaultWaitForPRChecksTimeoutSeconds = 120
defaultWaitForPRChecksPollIntervalSeconds = 5
)
// terminalRunStatuses lists Gitea Actions run statuses that never transition
// further, independent of whether a "conclusion" field is also present.
var terminalRunStatuses = map[string]bool{
"completed": true,
"success": true,
"failure": true,
"cancelled": true,
"skipped": true,
"failed": true,
"error": true,
}
func isRunTerminal(run map[string]any) bool {
if conclusion, ok := run["conclusion"].(string); ok && conclusion != "" {
return true
}
status, _ := run["status"].(string)
return terminalRunStatuses[strings.ToLower(status)]
}
func allRunsTerminal(runs []map[string]any) bool {
for _, run := range runs {
if !isRunTerminal(run) {
return false
}
}
return true
}
// waitForRunsUntilTerminal polls fetch until every run it returns is terminal
// or timeout elapses, sleeping pollInterval (capped to the remaining time)
// between polls so callers can inject a short pollInterval in tests.
func waitForRunsUntilTerminal(ctx context.Context, timeout, pollInterval time.Duration, fetch func(ctx context.Context) ([]map[string]any, error)) ([]map[string]any, bool, error) {
deadline := time.Now().Add(timeout)
for {
runs, err := fetch(ctx)
if err != nil {
return nil, false, err
}
if allRunsTerminal(runs) {
return runs, false, nil
}
remaining := time.Until(deadline)
if remaining <= 0 {
return runs, true, nil
}
wait := min(pollInterval, remaining)
select {
case <-ctx.Done():
return runs, false, ctx.Err()
case <-time.After(wait):
}
}
}
func fetchPullRequestHeadSHA(ctx context.Context, owner, repo string, pullNumber int64) (string, error) {
var result map[string]any
err := doJSONWithFallback(ctx, "GET",
[]string{
fmt.Sprintf("repos/%s/%s/pulls/%d", url.PathEscape(owner), url.PathEscape(repo), pullNumber),
},
nil, nil, &result,
)
if err != nil {
return "", err
}
head, ok := result["head"].(map[string]any)
if !ok {
return "", errors.New("pull request response missing head")
}
sha, ok := head["sha"].(string)
if !ok || sha == "" {
return "", errors.New("pull request response missing head.sha")
}
return sha, nil
}
func fetchActionRunsForSHA(ctx context.Context, owner, repo, sha string) ([]map[string]any, error) {
query := url.Values{}
query.Set("head_sha", sha)
var result map[string]any
err := doJSONWithFallback(ctx, "GET",
[]string{
fmt.Sprintf("repos/%s/%s/actions/runs", url.PathEscape(owner), url.PathEscape(repo)),
},
query, nil, &result,
)
if err != nil {
return nil, err
}
items, _ := result["workflow_runs"].([]any)
runs := make([]map[string]any, 0, len(items))
for _, item := range items {
if run, ok := item.(map[string]any); ok {
runs = append(runs, run)
}
}
return runs, nil
}
func waitForPRChecksFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
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)
}
pullNumber, err := params.GetIndex(args, "pull_number")
if err != nil || pullNumber <= 0 {
return to.ErrorResult(errors.New("pull_number is required"))
}
timeoutSeconds := params.GetOptionalInt(args, "timeout_seconds", defaultWaitForPRChecksTimeoutSeconds)
if timeoutSeconds <= 0 {
timeoutSeconds = defaultWaitForPRChecksTimeoutSeconds
}
pollIntervalSeconds := params.GetOptionalInt(args, "poll_interval_seconds", defaultWaitForPRChecksPollIntervalSeconds)
if pollIntervalSeconds <= 0 {
pollIntervalSeconds = defaultWaitForPRChecksPollIntervalSeconds
}
sha, err := fetchPullRequestHeadSHA(ctx, owner, repo, pullNumber)
if err != nil {
return to.ErrorResult(fmt.Errorf("get pull request err: %v", err))
}
runs, timedOut, err := waitForRunsUntilTerminal(ctx,
time.Duration(timeoutSeconds)*time.Second,
time.Duration(pollIntervalSeconds)*time.Second,
func(ctx context.Context) ([]map[string]any, error) {
return fetchActionRunsForSHA(ctx, owner, repo, sha)
},
)
if err != nil {
return to.ErrorResult(fmt.Errorf("wait for pr checks err: %v", err))
}
slimmedRuns := make([]map[string]any, 0, len(runs))
for _, run := range runs {
slimmedRuns = append(slimmedRuns, slimRun(run))
}
return to.TextResult(map[string]any{
"head_sha": sha,
"timed_out": timedOut,
"runs": slimmedRuns,
})
}
-169
View File
@@ -1,169 +0,0 @@
package actions
import (
"context"
"errors"
"fmt"
"net/http"
"net/http/httptest"
"strings"
"sync"
"sync/atomic"
"testing"
"time"
"gitea.com/gitea/gitea-mcp/pkg/flag"
"github.com/modelcontextprotocol/go-sdk/mcp"
)
func TestAllRunsTerminal(t *testing.T) {
tests := []struct {
name string
runs []map[string]any
want bool
}{
{"no runs", nil, true},
{"single completed run with conclusion", []map[string]any{{"status": "completed", "conclusion": "success"}}, true},
{"single running run", []map[string]any{{"status": "running", "conclusion": ""}}, false},
{"single waiting run", []map[string]any{{"status": "waiting"}}, false},
{"mixed terminal and running", []map[string]any{
{"status": "completed", "conclusion": "success"},
{"status": "running"},
}, false},
{"all terminal", []map[string]any{
{"status": "completed", "conclusion": "failure"},
{"status": "completed", "conclusion": "cancelled"},
}, true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := allRunsTerminal(tt.runs); got != tt.want {
t.Errorf("allRunsTerminal() = %v, want %v", got, tt.want)
}
})
}
}
func TestWaitForRunsUntilTerminal_ReturnsOnceTerminal(t *testing.T) {
calls := 0
fetch := func(ctx context.Context) ([]map[string]any, error) {
calls++
if calls < 3 {
return []map[string]any{{"status": "running"}}, nil
}
return []map[string]any{{"status": "completed", "conclusion": "success"}}, nil
}
runs, timedOut, err := waitForRunsUntilTerminal(context.Background(), time.Second, time.Millisecond, fetch)
if err != nil {
t.Fatalf("waitForRunsUntilTerminal() error = %v", err)
}
if timedOut {
t.Fatalf("expected timedOut = false")
}
if calls != 3 {
t.Fatalf("expected 3 fetch calls, got %d", calls)
}
if len(runs) != 1 || runs[0]["conclusion"] != "success" {
t.Fatalf("unexpected runs: %v", runs)
}
}
func TestWaitForRunsUntilTerminal_TimesOut(t *testing.T) {
fetch := func(ctx context.Context) ([]map[string]any, error) {
return []map[string]any{{"status": "running"}}, nil
}
runs, timedOut, err := waitForRunsUntilTerminal(context.Background(), 20*time.Millisecond, time.Millisecond, fetch)
if err != nil {
t.Fatalf("waitForRunsUntilTerminal() error = %v", err)
}
if !timedOut {
t.Fatalf("expected timedOut = true")
}
if len(runs) != 1 {
t.Fatalf("expected last fetched runs to be returned, got %v", runs)
}
}
func TestWaitForRunsUntilTerminal_PropagatesFetchError(t *testing.T) {
wantErr := errors.New("boom")
fetch := func(ctx context.Context) ([]map[string]any, error) {
return nil, wantErr
}
_, _, err := waitForRunsUntilTerminal(context.Background(), time.Second, time.Millisecond, fetch)
if !errors.Is(err, wantErr) {
t.Fatalf("waitForRunsUntilTerminal() error = %v, want %v", err, wantErr)
}
}
func Test_waitForPRChecksFn(t *testing.T) {
const (
owner = "octo"
repo = "demo"
pullNumber = 42
headSHA = "abc123"
)
var runsRequests int32
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
switch {
case r.URL.Path == fmt.Sprintf("/api/v1/repos/%s/%s/pulls/%d", owner, repo, pullNumber):
_, _ = fmt.Fprintf(w, `{"head":{"sha":%q}}`, headSHA)
case r.URL.Path == fmt.Sprintf("/api/v1/repos/%s/%s/actions/runs", owner, repo):
atomic.AddInt32(&runsRequests, 1)
if r.URL.Query().Get("head_sha") != headSHA {
t.Errorf("expected head_sha query param %q, got %q", headSHA, r.URL.Query().Get("head_sha"))
}
_, _ = fmt.Fprint(w, `{"workflow_runs":[{"id":1,"status":"completed","conclusion":"success"},{"id":2,"status":"completed","conclusion":"failure"}]}`)
default:
http.NotFound(w, r)
}
})
server := httptest.NewServer(handler)
defer server.Close()
var mu sync.Mutex
mu.Lock()
origHost, origToken := flag.Host, flag.Token
flag.Host, flag.Token = server.URL, ""
mu.Unlock()
defer func() {
mu.Lock()
flag.Host, flag.Token = origHost, origToken
mu.Unlock()
}()
args := map[string]any{
"owner": owner,
"repo": repo,
"pull_number": float64(pullNumber),
}
result, err := waitForPRChecksFn(context.Background(), args)
if err != nil {
t.Fatalf("waitForPRChecksFn() error = %v", err)
}
if atomic.LoadInt32(&runsRequests) != 1 {
t.Fatalf("expected exactly 1 runs request, got %d", runsRequests)
}
if len(result.Content) == 0 {
t.Fatalf("expected content in result")
}
textContent, ok := result.Content[0].(*mcp.TextContent)
if !ok {
t.Fatalf("expected text content, got %T", result.Content[0])
}
if !strings.Contains(textContent.Text, headSHA) {
t.Fatalf("expected result to mention head sha %q, got %s", headSHA, textContent.Text)
}
if !strings.Contains(textContent.Text, `"timed_out":false`) {
t.Fatalf("expected result to report timed_out=false, got %s", textContent.Text)
}
}
+29 -32
View File
@@ -69,28 +69,26 @@ func init() {
}) })
} }
type createBranchArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Branch string `json:"branch" required:"true"`
OldBranch string `json:"old_branch"`
}
func CreateBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) { func CreateBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner") var in createBranchArgs
if err != nil { if err := params.Bind(args, &in); err != nil {
return to.ErrorResult(err) return to.ErrorResult(err)
} }
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err)
}
branch, err := params.GetString(args, "branch")
if err != nil {
return to.ErrorResult(err)
}
oldBranch, _ := args["old_branch"].(string)
client, err := gitea.ClientFromContext(ctx) client, err := gitea.ClientFromContext(ctx)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err)) return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
} }
_, _, err = client.Repositories.CreateBranch(ctx, owner, repo, gitea_sdk.CreateBranchOption{ _, _, err = client.Repositories.CreateBranch(ctx, in.Owner, in.Repo, gitea_sdk.CreateBranchOption{
BranchName: branch, BranchName: in.Branch,
OldBranchName: oldBranch, OldBranchName: in.OldBranch,
}) })
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("create branch error: %v", err)) return to.ErrorResult(fmt.Errorf("create branch error: %v", err))
@@ -99,24 +97,22 @@ func CreateBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResu
return to.TextResult("Branch Created") return to.TextResult("Branch Created")
} }
type deleteBranchArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Branch string `json:"branch" required:"true"`
}
func DeleteBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) { func DeleteBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner") var in deleteBranchArgs
if err != nil { if err := params.Bind(args, &in); err != nil {
return to.ErrorResult(err)
}
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err)
}
branch, err := params.GetString(args, "branch")
if err != nil {
return to.ErrorResult(err) return to.ErrorResult(err)
} }
client, err := gitea.ClientFromContext(ctx) client, err := gitea.ClientFromContext(ctx)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err)) return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
} }
_, _, err = client.Repositories.DeleteRepoBranch(ctx, owner, repo, branch) _, _, err = client.Repositories.DeleteRepoBranch(ctx, in.Owner, in.Repo, in.Branch)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("delete branch error: %v", err)) return to.ErrorResult(fmt.Errorf("delete branch error: %v", err))
} }
@@ -124,13 +120,14 @@ func DeleteBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResu
return to.TextResult("Branch Deleted") return to.TextResult("Branch Deleted")
} }
type listBranchesArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
}
func ListBranchesFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) { func ListBranchesFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner") var in listBranchesArgs
if err != nil { if err := params.Bind(args, &in); err != nil {
return to.ErrorResult(err)
}
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err) return to.ErrorResult(err)
} }
page, pageSize := params.GetPagination(args, 30) page, pageSize := params.GetPagination(args, 30)
@@ -144,7 +141,7 @@ func ListBranchesFn(ctx context.Context, args map[string]any) (*mcp.CallToolResu
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err)) return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
} }
branches, _, err := client.Repositories.ListRepoBranches(ctx, owner, repo, opt) branches, _, err := client.Repositories.ListRepoBranches(ctx, in.Owner, in.Repo, opt)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("list branches error: %v", err)) return to.ErrorResult(fmt.Errorf("list branches error: %v", err))
} }
+60 -71
View File
@@ -102,30 +102,28 @@ type ContentLine struct {
Content string `json:"content"` Content string `json:"content"`
} }
type getFileContentArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Ref string `json:"ref"`
Path string `json:"path" required:"true"`
WithLines bool `json:"withLines"`
}
func GetFileContentFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) { func GetFileContentFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner") var in getFileContentArgs
if err != nil { if err := params.Bind(args, &in); err != nil {
return to.ErrorResult(err)
}
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err)
}
ref, _ := args["ref"].(string)
filePath, err := params.GetString(args, "path")
if err != nil {
return to.ErrorResult(err) return to.ErrorResult(err)
} }
client, err := gitea.ClientFromContext(ctx) client, err := gitea.ClientFromContext(ctx)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err)) return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
} }
content, _, err := client.Repositories.GetContents(ctx, owner, repo, ref, filePath) content, _, err := client.Repositories.GetContents(ctx, in.Owner, in.Repo, in.Ref, in.Path)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get file err: %v", err)) return to.ErrorResult(fmt.Errorf("get file err: %v", err))
} }
withLines, _ := args["withLines"].(bool) if in.WithLines {
if withLines {
rawContent, err := base64.StdEncoding.DecodeString(*content.Content) rawContent, err := base64.StdEncoding.DecodeString(*content.Content)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("decode base64 content err: %v", err)) return to.ErrorResult(fmt.Errorf("decode base64 content err: %v", err))
@@ -164,49 +162,45 @@ func GetFileContentFn(ctx context.Context, args map[string]any) (*mcp.CallToolRe
return to.TextResult(slimContents(content)) return to.TextResult(slimContents(content))
} }
type getDirContentArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Ref string `json:"ref"`
Path string `json:"path" required:"true"`
}
func GetDirContentFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) { func GetDirContentFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner") var in getDirContentArgs
if err != nil { if err := params.Bind(args, &in); err != nil {
return to.ErrorResult(err)
}
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err)
}
ref, _ := args["ref"].(string)
filePath, err := params.GetString(args, "path")
if err != nil {
return to.ErrorResult(err) return to.ErrorResult(err)
} }
client, err := gitea.ClientFromContext(ctx) client, err := gitea.ClientFromContext(ctx)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err)) return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
} }
content, _, err := client.Repositories.ListContents(ctx, owner, repo, ref, filePath) content, _, err := client.Repositories.ListContents(ctx, in.Owner, in.Repo, in.Ref, in.Path)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get dir content err: %v", err)) return to.ErrorResult(fmt.Errorf("get dir content err: %v", err))
} }
return to.TextResult(slimDirEntries(content)) return to.TextResult(slimDirEntries(content))
} }
type createOrUpdateFileArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Path string `json:"path" required:"true"`
Content string `json:"content"`
Message string `json:"message"`
BranchName string `json:"branch_name"`
NewBranchName string `json:"new_branch_name"`
SHA string `json:"sha"`
}
func CreateOrUpdateFileFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) { func CreateOrUpdateFileFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner") var in createOrUpdateFileArgs
if err != nil { if err := params.Bind(args, &in); err != nil {
return to.ErrorResult(err) return to.ErrorResult(err)
} }
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err)
}
filePath, err := params.GetString(args, "path")
if err != nil {
return to.ErrorResult(err)
}
content, _ := args["content"].(string)
message, _ := args["message"].(string)
branchName, _ := args["branch_name"].(string)
newBranchName, _ := args["new_branch_name"].(string)
sha, _ := args["sha"].(string)
client, err := gitea.ClientFromContext(ctx) client, err := gitea.ClientFromContext(ctx)
if err != nil { if err != nil {
@@ -214,20 +208,20 @@ func CreateOrUpdateFileFn(ctx context.Context, args map[string]any) (*mcp.CallTo
} }
fileOpt := gitea_sdk.FileOptions{ fileOpt := gitea_sdk.FileOptions{
Message: message, Message: in.Message,
BranchName: branchName, BranchName: in.BranchName,
NewBranchName: newBranchName, NewBranchName: in.NewBranchName,
} }
targetBranch := cmp.Or(newBranchName, branchName) targetBranch := cmp.Or(in.NewBranchName, in.BranchName)
if sha != "" { if in.SHA != "" {
// Update existing file // Update existing file
opt := gitea_sdk.UpdateFileOptions{ opt := gitea_sdk.UpdateFileOptions{
SHA: sha, SHA: in.SHA,
Content: base64.StdEncoding.EncodeToString([]byte(content)), Content: base64.StdEncoding.EncodeToString([]byte(in.Content)),
FileOptions: fileOpt, FileOptions: fileOpt,
} }
_, _, err = client.Repositories.UpdateFile(ctx, owner, repo, filePath, opt) _, _, err = client.Repositories.UpdateFile(ctx, in.Owner, in.Repo, in.Path, opt)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("update file err: %v", err)) return to.ErrorResult(fmt.Errorf("update file err: %v", err))
} }
@@ -236,47 +230,42 @@ func CreateOrUpdateFileFn(ctx context.Context, args map[string]any) (*mcp.CallTo
// Create new file // Create new file
opt := gitea_sdk.CreateFileOptions{ opt := gitea_sdk.CreateFileOptions{
Content: base64.StdEncoding.EncodeToString([]byte(content)), Content: base64.StdEncoding.EncodeToString([]byte(in.Content)),
FileOptions: fileOpt, FileOptions: fileOpt,
} }
_, _, err = client.Repositories.CreateFile(ctx, owner, repo, filePath, opt) _, _, err = client.Repositories.CreateFile(ctx, in.Owner, in.Repo, in.Path, opt)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("create file err: %v", err)) return to.ErrorResult(fmt.Errorf("create file err: %v", err))
} }
return to.TextResult("Create file success on branch " + targetBranch) return to.TextResult("Create file success on branch " + targetBranch)
} }
type deleteFileArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Path string `json:"path" required:"true"`
Message string `json:"message"`
BranchName string `json:"branch_name"`
SHA string `json:"sha" required:"true"`
}
func DeleteFileFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) { func DeleteFileFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner") var in deleteFileArgs
if err != nil { if err := params.Bind(args, &in); err != nil {
return to.ErrorResult(err)
}
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err)
}
filePath, err := params.GetString(args, "path")
if err != nil {
return to.ErrorResult(err)
}
message, _ := args["message"].(string)
branchName, _ := args["branch_name"].(string)
sha, err := params.GetString(args, "sha")
if err != nil {
return to.ErrorResult(err) return to.ErrorResult(err)
} }
opt := gitea_sdk.DeleteFileOptions{ opt := gitea_sdk.DeleteFileOptions{
FileOptions: gitea_sdk.FileOptions{ FileOptions: gitea_sdk.FileOptions{
Message: message, Message: in.Message,
BranchName: branchName, BranchName: in.BranchName,
}, },
SHA: sha, SHA: in.SHA,
} }
client, err := gitea.ClientFromContext(ctx) client, err := gitea.ClientFromContext(ctx)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err)) return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
} }
_, err = client.Repositories.DeleteFile(ctx, owner, repo, filePath, opt) _, err = client.Repositories.DeleteFile(ctx, in.Owner, in.Repo, in.Path, opt)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("delete file err: %v", err)) return to.ErrorResult(fmt.Errorf("delete file err: %v", err))
} }
+12 -14
View File
@@ -37,20 +37,18 @@ func init() {
}) })
} }
type getRepoTreeArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
TreeSHA string `json:"tree_sha" required:"true"`
Recursive bool `json:"recursive"`
}
func GetRepoTreeFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) { func GetRepoTreeFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner") var in getRepoTreeArgs
if err != nil { if err := params.Bind(args, &in); err != nil {
return to.ErrorResult(err) return to.ErrorResult(err)
} }
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err)
}
treeSHA, err := params.GetString(args, "tree_sha")
if err != nil {
return to.ErrorResult(err)
}
recursive, _ := args["recursive"].(bool)
page, pageSize := params.GetPagination(args, 30) page, pageSize := params.GetPagination(args, 30)
opt := gitea_sdk.ListTreeOptions{ opt := gitea_sdk.ListTreeOptions{
@@ -58,14 +56,14 @@ func GetRepoTreeFn(ctx context.Context, args map[string]any) (*mcp.CallToolResul
Page: page, Page: page,
PageSize: pageSize, PageSize: pageSize,
}, },
Ref: treeSHA, Ref: in.TreeSHA,
Recursive: recursive, Recursive: in.Recursive,
} }
client, err := gitea.ClientFromContext(ctx) client, err := gitea.ClientFromContext(ctx)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err)) return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
} }
tree, _, err := client.Git.GetTrees(ctx, owner, repo, opt) tree, _, err := client.Git.GetTrees(ctx, in.Owner, in.Repo, opt)
if err != nil { if err != nil {
return to.ErrorResult(fmt.Errorf("get repository tree err: %v", err)) return to.ErrorResult(fmt.Errorf("get repository tree err: %v", err))
} }
+55
View File
@@ -0,0 +1,55 @@
package params
import (
"encoding/json"
"fmt"
"reflect"
"strings"
)
// Bind decodes args into out, a pointer to a struct, replacing the repeated
// args["x"].(string)/!ok extraction pattern. It round-trips args through JSON
// so JSON numbers land in the correct Go numeric field types.
//
// Struct fields tagged `required:"true"` must be present in args; a missing
// key, or an empty string value for a string field, returns an error naming
// the field's json tag.
func Bind(args map[string]any, out any) error {
v := reflect.ValueOf(out)
if v.Kind() != reflect.Pointer || v.Elem().Kind() != reflect.Struct {
return fmt.Errorf("params.Bind: out must be a pointer to a struct, got %T", out)
}
if err := checkRequiredFields(args, v.Elem().Type()); err != nil {
return err
}
data, err := json.Marshal(args)
if err != nil {
return fmt.Errorf("params.Bind: marshal args: %w", err)
}
if err := json.Unmarshal(data, out); err != nil {
return fmt.Errorf("params.Bind: %w", err)
}
return nil
}
func checkRequiredFields(args map[string]any, t reflect.Type) error {
for field := range t.Fields() {
if field.Tag.Get("required") != "true" {
continue
}
name, _, _ := strings.Cut(field.Tag.Get("json"), ",")
if name == "" || name == "-" {
continue
}
val, ok := args[name]
if !ok {
return fmt.Errorf("%s is required", name)
}
if s, isString := val.(string); isString && s == "" {
return fmt.Errorf("%s is required", name)
}
}
return nil
}
+132
View File
@@ -0,0 +1,132 @@
package params
import (
"strings"
"testing"
)
func TestBind_RequiredFieldsPresent(t *testing.T) {
type args struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
}
var out args
err := Bind(map[string]any{"owner": "gitea", "repo": "gitea-mcp"}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if out.Owner != "gitea" || out.Repo != "gitea-mcp" {
t.Errorf("Bind() = %+v, want Owner=gitea Repo=gitea-mcp", out)
}
}
func TestBind_RequiredFieldMissing(t *testing.T) {
type args struct {
Owner string `json:"owner" required:"true"`
}
var out args
err := Bind(map[string]any{}, &out)
if err == nil {
t.Fatal("Bind() expected error, got nil")
}
if !strings.Contains(err.Error(), "owner") {
t.Errorf("Bind() error = %v, want mentioning %q", err, "owner")
}
}
func TestBind_RequiredStringFieldEmpty(t *testing.T) {
type args struct {
Owner string `json:"owner" required:"true"`
}
var out args
err := Bind(map[string]any{"owner": ""}, &out)
if err == nil {
t.Fatal("Bind() expected error for empty required string, got nil")
}
}
func TestBind_OptionalFieldDefaultsToZeroValue(t *testing.T) {
type args struct {
Owner string `json:"owner" required:"true"`
OldBranch string `json:"old_branch"`
}
var out args
err := Bind(map[string]any{"owner": "gitea"}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if out.OldBranch != "" {
t.Errorf("Bind() OldBranch = %q, want empty", out.OldBranch)
}
}
func TestBind_NumericConversion(t *testing.T) {
type args struct {
Page int `json:"page"`
PerPage int64 `json:"per_page"`
}
var out args
err := Bind(map[string]any{"page": float64(2), "per_page": float64(40)}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if out.Page != 2 || out.PerPage != 40 {
t.Errorf("Bind() = %+v, want Page=2 PerPage=40", out)
}
}
func TestBind_Boolean(t *testing.T) {
type args struct {
Recursive bool `json:"recursive"`
}
var out args
err := Bind(map[string]any{"recursive": true}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if !out.Recursive {
t.Errorf("Bind() Recursive = false, want true")
}
}
func TestBind_Array(t *testing.T) {
type args struct {
Labels []string `json:"labels"`
IDs []int64 `json:"ids"`
}
var out args
err := Bind(map[string]any{
"labels": []any{"bug", "help wanted"},
"ids": []any{float64(1), float64(2)},
}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if len(out.Labels) != 2 || out.Labels[0] != "bug" || out.Labels[1] != "help wanted" {
t.Errorf("Bind() Labels = %v, want [bug help wanted]", out.Labels)
}
if len(out.IDs) != 2 || out.IDs[0] != 1 || out.IDs[1] != 2 {
t.Errorf("Bind() IDs = %v, want [1 2]", out.IDs)
}
}
func TestBind_InvalidFieldType(t *testing.T) {
type args struct {
Page int `json:"page"`
}
var out args
err := Bind(map[string]any{"page": "not-a-number"}, &out)
if err == nil {
t.Fatal("Bind() expected error for invalid numeric field, got nil")
}
}
func TestBind_NonPointerRejected(t *testing.T) {
type args struct {
Owner string `json:"owner"`
}
err := Bind(map[string]any{}, args{})
if err == nil {
t.Fatal("Bind() expected error for non-pointer out, got nil")
}
}