mirror of
https://gitea.com/gitea/gitea-mcp.git
synced 2026-08-27 02:27:45 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2ffb16ba1e |
@@ -20,14 +20,6 @@ make install
|
||||
|
||||
Pass the Gitea host and access token as command-line flags or environment variables, flags take precedence. Run `gitea-mcp --help` for the full list of flags and environment variables. Logs are written to `$HOME/.gitea-mcp/gitea-mcp.log`, add `-d` for debug logging.
|
||||
|
||||
Set `GITEA_EXTRA_HEADERS` to a JSON object of header name/value pairs to send with every outbound request to Gitea, for example when Gitea sits behind Cloudflare Access:
|
||||
|
||||
```bash
|
||||
export GITEA_EXTRA_HEADERS='{"CF-Access-Client-Id":"id","CF-Access-Client-Secret":"secret"}'
|
||||
```
|
||||
|
||||
These headers never override `Authorization`, `Content-Type`, or `Accept` set by `gitea-mcp` itself.
|
||||
|
||||
### MCP protocol and HTTP transport
|
||||
|
||||
The server supports MCP up to `2026-07-28` and negotiates down to the client's version, advertising only the `tools` capability. Tool and Gitea failures return a `tools/call` result with `result.isError: true`, while malformed requests and server faults stay JSON-RPC errors.
|
||||
|
||||
-15
@@ -2,11 +2,9 @@ package cmd
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
@@ -88,7 +86,6 @@ func initFlagSet(fs *flag.FlagSet, args []string, getenv func(string) string, re
|
||||
fmt.Fprintf(w, " GITEA_ACCESS_TOKEN\tProvide access token\n")
|
||||
fmt.Fprintf(w, " GITEA_ACCESS_TOKEN_FILE\tPath to a file containing the access token (e.g. a Docker secret)\n")
|
||||
fmt.Fprintf(w, " GITEA_DEBUG\tSet to 'true' for debug mode\n")
|
||||
fmt.Fprintf(w, " GITEA_EXTRA_HEADERS\tJSON object of extra HTTP headers to send with Gitea API requests\n")
|
||||
fmt.Fprintf(w, " GITEA_HOST\tOverride Gitea host URL\n")
|
||||
fmt.Fprintf(w, " GITEA_INSECURE\tSet to 'true' to ignore TLS errors\n")
|
||||
fmt.Fprintf(w, " GITEA_MAX_INLINE_ATTACHMENT_BYTES\tOverride inline image attachment size limit in bytes\n")
|
||||
@@ -167,18 +164,6 @@ func initFlagSet(fs *flag.FlagSet, args []string, getenv func(string) string, re
|
||||
flagPkg.MaxInlineAttachmentBytes = parsed
|
||||
}
|
||||
}
|
||||
if val := getenv("GITEA_EXTRA_HEADERS"); val != "" {
|
||||
var headers map[string]string
|
||||
if err := json.Unmarshal([]byte(val), &headers); err != nil {
|
||||
fmt.Fprintf(stderr, "invalid GITEA_EXTRA_HEADERS: %v\n", err)
|
||||
osExit(1)
|
||||
}
|
||||
extraHeaders := make(http.Header, len(headers))
|
||||
for name, value := range headers {
|
||||
extraHeaders.Set(name, value)
|
||||
}
|
||||
flagPkg.ExtraHeaders = extraHeaders
|
||||
}
|
||||
}
|
||||
|
||||
// normalizeScope trims whitespace, lowercases, and converts internal spaces
|
||||
|
||||
@@ -5,7 +5,6 @@ import (
|
||||
"flag"
|
||||
"maps"
|
||||
"slices"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
flagPkg "gitea.com/gitea/gitea-mcp/pkg/flag"
|
||||
@@ -96,54 +95,3 @@ func TestInitFlagSetScopes(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestInitFlagSetExtraHeaders(t *testing.T) {
|
||||
t.Cleanup(func() { flagPkg.ExtraHeaders = nil })
|
||||
|
||||
getenv := func(key string) string {
|
||||
if key == "GITEA_EXTRA_HEADERS" {
|
||||
return `{"CF-Access-Client-Id":"id","CF-Access-Client-Secret":"secret"}`
|
||||
}
|
||||
return ""
|
||||
}
|
||||
readFile := func(string) ([]byte, error) { return nil, nil }
|
||||
fs := flag.NewFlagSet("test", flag.ContinueOnError)
|
||||
var stderr bytes.Buffer
|
||||
|
||||
initFlagSet(fs, []string{}, getenv, readFile, &stderr)
|
||||
|
||||
if got := flagPkg.ExtraHeaders.Get("CF-Access-Client-Id"); got != "id" {
|
||||
t.Errorf("ExtraHeaders[CF-Access-Client-Id] = %q, want %q", got, "id")
|
||||
}
|
||||
if got := flagPkg.ExtraHeaders.Get("CF-Access-Client-Secret"); got != "secret" {
|
||||
t.Errorf("ExtraHeaders[CF-Access-Client-Secret] = %q, want %q", got, "secret")
|
||||
}
|
||||
}
|
||||
|
||||
func TestInitFlagSetExtraHeadersInvalidJSON(t *testing.T) {
|
||||
t.Cleanup(func() { flagPkg.ExtraHeaders = nil })
|
||||
|
||||
origOsExit := osExit
|
||||
var exitCode int
|
||||
osExit = func(code int) { exitCode = code }
|
||||
t.Cleanup(func() { osExit = origOsExit })
|
||||
|
||||
getenv := func(key string) string {
|
||||
if key == "GITEA_EXTRA_HEADERS" {
|
||||
return `not-json`
|
||||
}
|
||||
return ""
|
||||
}
|
||||
readFile := func(string) ([]byte, error) { return nil, nil }
|
||||
fs := flag.NewFlagSet("test", flag.ContinueOnError)
|
||||
var stderr bytes.Buffer
|
||||
|
||||
initFlagSet(fs, []string{}, getenv, readFile, &stderr)
|
||||
|
||||
if exitCode != 1 {
|
||||
t.Errorf("exitCode = %d, want 1", exitCode)
|
||||
}
|
||||
if !strings.Contains(stderr.String(), "GITEA_EXTRA_HEADERS") {
|
||||
t.Errorf("stderr = %q, want mention of GITEA_EXTRA_HEADERS", stderr.String())
|
||||
}
|
||||
}
|
||||
|
||||
+41
-2
@@ -20,6 +20,13 @@ import (
|
||||
|
||||
var Tool = tool.New("pull_request")
|
||||
|
||||
// commentWithAssets wraps the SDK Comment to capture the `assets` field that
|
||||
// the SDK currently drops on the issue comments endpoint.
|
||||
type commentWithAssets struct {
|
||||
gitea_sdk.Comment
|
||||
Assets []*gitea_sdk.Attachment `json:"assets"`
|
||||
}
|
||||
|
||||
const (
|
||||
ListRepoPullRequestsToolName = "list_pull_requests"
|
||||
PullRequestReadToolName = "pull_request_read"
|
||||
@@ -43,9 +50,9 @@ var (
|
||||
|
||||
PullRequestReadTool = tool.NewDefinition(
|
||||
PullRequestReadToolName,
|
||||
"Read pull request: details, diff, changed files, head commit status, reviews, review comments.",
|
||||
"Read pull request: details, diff, changed files, head commit status, reviews, review comments, discussion comments.",
|
||||
annotation.ReadOnly("Read pull request details"),
|
||||
tool.String("method", tool.Required(), tool.Enum("get", "get_diff", "get_files", "get_status", "get_reviews", "get_review", "get_review_comments")),
|
||||
tool.String("method", tool.Required(), tool.Enum("get", "get_diff", "get_files", "get_status", "get_reviews", "get_review", "get_review_comments", "get_comments")),
|
||||
tool.String("owner", tool.Required(), tool.Description(params.OwnerDesc)),
|
||||
tool.String("repo", tool.Required(), tool.Description(params.RepoDesc)),
|
||||
tool.Number("pull_number", tool.Required()),
|
||||
@@ -151,6 +158,8 @@ func pullRequestReadFn(ctx context.Context, args map[string]any) (*mcp.CallToolR
|
||||
return getPullRequestReviewFn(ctx, args)
|
||||
case "get_review_comments":
|
||||
return listPullRequestReviewCommentsFn(ctx, args)
|
||||
case "get_comments":
|
||||
return listPullRequestCommentsFn(ctx, args)
|
||||
default:
|
||||
return to.ErrorResult(fmt.Errorf("unknown method: %s", method))
|
||||
}
|
||||
@@ -603,6 +612,36 @@ func listPullRequestReviewCommentsFn(ctx context.Context, args map[string]any) (
|
||||
return to.TextResult(slimReviewComments(comments))
|
||||
}
|
||||
|
||||
func listPullRequestCommentsFn(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)
|
||||
}
|
||||
index, err := params.GetIndex(args, "pull_number")
|
||||
if err != nil {
|
||||
return to.ErrorResult(err)
|
||||
}
|
||||
|
||||
// PRs are issues internally, so the regular discussion comments live on
|
||||
// the issue comments endpoint rather than a pull-specific one.
|
||||
var comments []commentWithAssets
|
||||
path := fmt.Sprintf("repos/%s/%s/issues/%d/comments", url.PathEscape(owner), url.PathEscape(repo), index)
|
||||
if _, err := gitea.DoJSON(ctx, "GET", path, nil, nil, &comments); err != nil {
|
||||
return to.ErrorResult(fmt.Errorf("get %v/%v/pr/%v comments err: %v", owner, repo, index, err))
|
||||
}
|
||||
out := make([]map[string]any, 0, len(comments))
|
||||
for i := range comments {
|
||||
m := slimComment(&comments[i].Comment)
|
||||
m["body"] = slim.BodyWithAttachments(comments[i].Body, comments[i].Assets)
|
||||
out = append(out, m)
|
||||
}
|
||||
return to.TextResult(out)
|
||||
}
|
||||
|
||||
func createPullRequestReviewFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
|
||||
owner, err := params.GetString(args, "owner")
|
||||
if err != nil {
|
||||
|
||||
@@ -943,6 +943,91 @@ func Test_closePullRequestFn(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func Test_listPullRequestCommentsFn_missingArgs(t *testing.T) {
|
||||
result, err := listPullRequestCommentsFn(context.Background(), map[string]any{
|
||||
"owner": "octo",
|
||||
"repo": "demo",
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("listPullRequestCommentsFn() error = %v", err)
|
||||
}
|
||||
if result == nil || !result.IsError {
|
||||
t.Fatalf("listPullRequestCommentsFn() result = %#v, want an error result for missing pull_number", result)
|
||||
}
|
||||
}
|
||||
|
||||
func Test_listPullRequestCommentsFn_apiError(t *testing.T) {
|
||||
const (
|
||||
owner = "octo"
|
||||
repo = "demo"
|
||||
index = 7
|
||||
)
|
||||
|
||||
serveStub(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != fmt.Sprintf("/api/v1/repos/%s/%s/issues/%d/comments", owner, repo, index) {
|
||||
t.Errorf("unexpected request: %s %s", r.Method, r.URL.Path)
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
http.Error(w, "boom", http.StatusInternalServerError)
|
||||
})
|
||||
|
||||
args := map[string]any{
|
||||
"owner": owner, "repo": repo, "pull_number": float64(index),
|
||||
}
|
||||
result, err := listPullRequestCommentsFn(context.Background(), args)
|
||||
if err != nil {
|
||||
t.Fatalf("listPullRequestCommentsFn() error = %v", err)
|
||||
}
|
||||
if result == nil || !result.IsError {
|
||||
t.Fatalf("listPullRequestCommentsFn() result = %#v, want an error result on API failure", result)
|
||||
}
|
||||
}
|
||||
|
||||
func Test_listPullRequestCommentsFn_decodesComments(t *testing.T) {
|
||||
const (
|
||||
owner = "octo"
|
||||
repo = "demo"
|
||||
index = 7
|
||||
)
|
||||
|
||||
serveStub(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != fmt.Sprintf("/api/v1/repos/%s/%s/issues/%d/comments", owner, repo, index) {
|
||||
t.Errorf("unexpected request: %s %s", r.Method, r.URL.Path)
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write([]byte(`[
|
||||
{"id": 1, "body": "see this", "assets": [
|
||||
{"id": 9, "name": "log.txt", "size": 200, "browser_download_url": "https://example/log.txt"}
|
||||
]},
|
||||
{"id": 2, "body": "no attachment", "assets": []}
|
||||
]`))
|
||||
})
|
||||
|
||||
args := map[string]any{
|
||||
"method": "get_comments", "owner": owner, "repo": repo, "pull_number": float64(index),
|
||||
}
|
||||
result, err := pullRequestReadFn(context.Background(), args)
|
||||
if err != nil {
|
||||
t.Fatalf("pullRequestReadFn() error = %v", err)
|
||||
}
|
||||
if result.IsError {
|
||||
t.Fatalf("unexpected error result: %v", result.Content)
|
||||
}
|
||||
body := result.Content[0].(*mcp.TextContent).Text
|
||||
if !strings.Contains(body, `[log.txt](https://example/log.txt)`) {
|
||||
t.Fatalf("expected attachment markdown inlined in body, got: %s", body)
|
||||
}
|
||||
if !strings.Contains(body, `"no attachment"`) {
|
||||
t.Fatalf("expected second comment body preserved, got: %s", body)
|
||||
}
|
||||
if strings.Contains(body, `"assets"`) {
|
||||
t.Fatalf("assets should be inlined into body, not a separate field: %s", body)
|
||||
}
|
||||
}
|
||||
|
||||
func Test_reopenPullRequestFn(t *testing.T) {
|
||||
const (
|
||||
owner = "octo"
|
||||
|
||||
@@ -164,3 +164,17 @@ func slimReviewComments(comments []*gitea_sdk.PullReviewComment) []map[string]an
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
func slimComment(c *gitea_sdk.Comment) map[string]any {
|
||||
if c == nil {
|
||||
return nil
|
||||
}
|
||||
return map[string]any{
|
||||
"id": c.ID,
|
||||
"body": c.Body,
|
||||
"user": slim.UserLogin(c.Poster),
|
||||
"html_url": c.HTMLURL,
|
||||
"created_at": c.Created,
|
||||
"updated_at": c.Updated,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
package flag
|
||||
|
||||
import "net/http"
|
||||
|
||||
var (
|
||||
Host string
|
||||
Bind string
|
||||
@@ -17,5 +15,4 @@ var (
|
||||
Debug bool
|
||||
AllowedTools map[string]struct{}
|
||||
AllowedScopes map[string]struct{}
|
||||
ExtraHeaders http.Header
|
||||
)
|
||||
|
||||
+1
-27
@@ -30,32 +30,6 @@ func sharedTransport() *http.Transport {
|
||||
return sharedTrans
|
||||
}
|
||||
|
||||
// extraHeaderTransport injects flag.ExtraHeaders into every request, without
|
||||
// overriding headers the caller already set (e.g. Authorization, Content-Type,
|
||||
// Accept). It reads flag.ExtraHeaders on each round trip rather than caching
|
||||
// it, so tests can change it between requests.
|
||||
type extraHeaderTransport struct {
|
||||
base http.RoundTripper
|
||||
}
|
||||
|
||||
func (t *extraHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||
headers := flag.ExtraHeaders
|
||||
if len(headers) == 0 {
|
||||
return t.base.RoundTrip(req)
|
||||
}
|
||||
cloned := req.Clone(req.Context())
|
||||
for name, values := range headers {
|
||||
if cloned.Header.Get(name) == "" {
|
||||
cloned.Header[name] = values
|
||||
}
|
||||
}
|
||||
return t.base.RoundTrip(cloned)
|
||||
}
|
||||
|
||||
func giteaTransport() http.RoundTripper {
|
||||
return &extraHeaderTransport{base: sharedTransport()}
|
||||
}
|
||||
|
||||
// NewClient returns a cached *gitea.Client keyed by host+token. The SDK's per-client
|
||||
// version cache and the shared transport let us reuse keep-alive connections
|
||||
// and avoid the SDK's /api/v1/version preflight on every tool call.
|
||||
@@ -66,7 +40,7 @@ func NewClient(token string) (*gitea.Client, error) {
|
||||
}
|
||||
|
||||
httpClient := &http.Client{
|
||||
Transport: giteaTransport(),
|
||||
Transport: sharedTransport(),
|
||||
CheckRedirect: checkRedirect,
|
||||
}
|
||||
opts := []gitea.ClientOption{
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
package gitea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"gitea.com/gitea/gitea-mcp/pkg/flag"
|
||||
)
|
||||
|
||||
func TestNewClient_SendsExtraHeaders(t *testing.T) {
|
||||
var gotClientID, gotAuthorization string
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
gotClientID = r.Header.Get("CF-Access-Client-Id")
|
||||
gotAuthorization = r.Header.Get("Authorization")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write([]byte(`{"login":"octocat"}`))
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
origHost := flag.Host
|
||||
origExtraHeaders := flag.ExtraHeaders
|
||||
defer func() {
|
||||
flag.Host = origHost
|
||||
flag.ExtraHeaders = origExtraHeaders
|
||||
}()
|
||||
flag.Host = srv.URL
|
||||
flag.ExtraHeaders = http.Header{
|
||||
"Cf-Access-Client-Id": []string{"client-id"},
|
||||
"Authorization": []string{"should-not-override"},
|
||||
}
|
||||
|
||||
client, err := NewClient("the-token")
|
||||
if err != nil {
|
||||
t.Fatalf("NewClient returned error: %v", err)
|
||||
}
|
||||
if _, _, err := client.Users.GetMyUserInfo(context.Background()); err != nil {
|
||||
t.Fatalf("GetMyUserInfo returned error: %v", err)
|
||||
}
|
||||
|
||||
if gotClientID != "client-id" {
|
||||
t.Fatalf("CF-Access-Client-Id header = %q, want %q", gotClientID, "client-id")
|
||||
}
|
||||
if gotAuthorization != "token the-token" {
|
||||
t.Fatalf("Authorization header = %q, want %q", gotAuthorization, "token the-token")
|
||||
}
|
||||
}
|
||||
+2
-2
@@ -59,7 +59,7 @@ var (
|
||||
func restHTTPClient() *http.Client {
|
||||
restClientOnce.Do(func() {
|
||||
restClient = &http.Client{
|
||||
Transport: giteaTransport(),
|
||||
Transport: sharedTransport(),
|
||||
Timeout: httpClientTimeout,
|
||||
CheckRedirect: checkRedirect,
|
||||
}
|
||||
@@ -180,7 +180,7 @@ func DoJSON(ctx context.Context, method, path string, query url.Values, body, re
|
||||
|
||||
func attachmentHTTPClient(origin *url.URL) *http.Client {
|
||||
return &http.Client{
|
||||
Transport: giteaTransport(),
|
||||
Transport: sharedTransport(),
|
||||
CheckRedirect: func(req *http.Request, via []*http.Request) error {
|
||||
if err := checkRedirect(req, via); err != nil {
|
||||
return err
|
||||
|
||||
@@ -62,44 +62,3 @@ func TestDoJSON_LimitsErrorResponseBody(t *testing.T) {
|
||||
t.Fatalf("expected body length %d, got %d", errBodySnippetSize, len(httpErr.Body))
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoJSON_SendsExtraHeaders(t *testing.T) {
|
||||
var gotClientID, gotAuthorization string
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
gotClientID = r.Header.Get("CF-Access-Client-Id")
|
||||
gotAuthorization = r.Header.Get("Authorization")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = io.WriteString(w, "{}")
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
origHost := flag.Host
|
||||
origToken := flag.Token
|
||||
origExtraHeaders := flag.ExtraHeaders
|
||||
defer func() {
|
||||
flag.Host = origHost
|
||||
flag.Token = origToken
|
||||
flag.ExtraHeaders = origExtraHeaders
|
||||
}()
|
||||
flag.Host = srv.URL
|
||||
flag.Token = "the-token"
|
||||
flag.ExtraHeaders = http.Header{
|
||||
"Cf-Access-Client-Id": []string{"client-id"},
|
||||
"Authorization": []string{"should-not-override"},
|
||||
}
|
||||
|
||||
var out map[string]any
|
||||
status, err := DoJSON(context.Background(), http.MethodGet, "repos/owner/repo", nil, nil, &out)
|
||||
if err != nil {
|
||||
t.Fatalf("DoJSON returned error: %v", err)
|
||||
}
|
||||
if status != http.StatusOK {
|
||||
t.Fatalf("expected status %d, got %d", http.StatusOK, status)
|
||||
}
|
||||
if gotClientID != "client-id" {
|
||||
t.Fatalf("CF-Access-Client-Id header = %q, want %q", gotClientID, "client-id")
|
||||
}
|
||||
if gotAuthorization != "token the-token" {
|
||||
t.Fatalf("Authorization header = %q, want %q", gotAuthorization, "token the-token")
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user