Inline issue/comment attachments in body (#183)
The Gitea API returns an `assets` array on issue and comment responses, but the SDK structs drop it — so attachments are invisible to MCP agents.
Append each attachment as a `[name](url)` markdown link at the end of the body, mirroring how GitHub embeds attachments inline (which `github-mcp-server` preserves as-is).
**Coverage:**
- `issue_read get` — issue body attachments
- `issue_read get_comments` — issue and PR conversation comment attachments (same endpoint)
- `pull_request_read get` — PR description attachments (Gitea's `/pulls/` endpoint omits `assets`, so a follow-up best-effort call to `/issues/{n}/assets` surfaces them; PRs are issues internally)
PR review summaries and line-comment reviews don't support attachments per the Gitea API spec, so nothing to do there.
Closes https://gitea.com/gitea/gitea-mcp/issues/182
---
This PR was written with the help of Claude Opus 4.7
Reviewed-on: https://gitea.com/gitea/gitea-mcp/pulls/183
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: silverwind <me@silverwind.io>
Co-committed-by: silverwind <me@silverwind.io>
This commit is contained in:
+29
-17
@@ -3,6 +3,7 @@ package issue
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net/url"
|
||||
|
||||
"gitea.com/gitea/gitea-mcp/pkg/gitea"
|
||||
"gitea.com/gitea/gitea-mcp/pkg/log"
|
||||
@@ -15,6 +16,18 @@ import (
|
||||
"github.com/mark3labs/mcp-go/server"
|
||||
)
|
||||
|
||||
// issueWithAssets / commentWithAssets wrap the SDK types to capture the
|
||||
// `assets` field that the SDK currently drops on these endpoints.
|
||||
type issueWithAssets struct {
|
||||
gitea_sdk.Issue
|
||||
Assets []*gitea_sdk.Attachment `json:"assets"`
|
||||
}
|
||||
|
||||
type commentWithAssets struct {
|
||||
gitea_sdk.Comment
|
||||
Assets []*gitea_sdk.Attachment `json:"assets"`
|
||||
}
|
||||
|
||||
var Tool = tool.New()
|
||||
|
||||
const (
|
||||
@@ -142,16 +155,14 @@ func getIssueByIndexFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallT
|
||||
if err != nil {
|
||||
return to.ErrorResult(err)
|
||||
}
|
||||
client, err := gitea.ClientFromContext(ctx)
|
||||
if err != nil {
|
||||
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
|
||||
}
|
||||
issue, _, err := client.GetIssue(owner, repo, index)
|
||||
if err != nil {
|
||||
var issue issueWithAssets
|
||||
path := fmt.Sprintf("repos/%s/%s/issues/%d", url.PathEscape(owner), url.PathEscape(repo), index)
|
||||
if _, err := gitea.DoJSON(ctx, "GET", path, nil, nil, &issue); err != nil {
|
||||
return to.ErrorResult(fmt.Errorf("get %v/%v/issue/%v err: %v", owner, repo, index, err))
|
||||
}
|
||||
|
||||
return to.TextResult(slimIssue(issue))
|
||||
m := slimIssue(&issue.Issue)
|
||||
m["body"] = bodyWithAttachments(issue.Body, issue.Assets)
|
||||
return to.TextResult(m)
|
||||
}
|
||||
|
||||
func listRepoIssuesFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
||||
@@ -377,17 +388,18 @@ func getIssueCommentsByIndexFn(ctx context.Context, req mcp.CallToolRequest) (*m
|
||||
if err != nil {
|
||||
return to.ErrorResult(err)
|
||||
}
|
||||
opt := gitea_sdk.ListIssueCommentOptions{}
|
||||
client, err := gitea.ClientFromContext(ctx)
|
||||
if err != nil {
|
||||
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
|
||||
}
|
||||
issue, _, err := client.ListIssueComments(owner, repo, index, opt)
|
||||
if err != nil {
|
||||
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/issues/%v/comments err: %v", owner, repo, index, err))
|
||||
}
|
||||
|
||||
return to.TextResult(slimComments(issue))
|
||||
out := make([]map[string]any, 0, len(comments))
|
||||
for i := range comments {
|
||||
m := slimComment(&comments[i].Comment)
|
||||
m["body"] = bodyWithAttachments(comments[i].Body, comments[i].Assets)
|
||||
out = append(out, m)
|
||||
}
|
||||
return to.TextResult(out)
|
||||
}
|
||||
|
||||
func getIssueLabelsFn(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
||||
|
||||
@@ -166,3 +166,104 @@ func Test_createIssueFn_labels(t *testing.T) {
|
||||
t.Fatalf("expected due_date to be set")
|
||||
}
|
||||
}
|
||||
|
||||
func Test_getIssueByIndexFn_includesAttachments(t *testing.T) {
|
||||
const (
|
||||
owner = "octo"
|
||||
repo = "demo"
|
||||
)
|
||||
|
||||
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/api/v1/version":
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write([]byte(`{"version":"1.12.0"}`))
|
||||
case fmt.Sprintf("/api/v1/repos/%s/%s/issues/42", owner, repo):
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write([]byte(`{
|
||||
"number": 42,
|
||||
"title": "bug with screenshot",
|
||||
"body": "see attached",
|
||||
"state": "open",
|
||||
"assets": [
|
||||
{"id": 1, "name": "shot.png", "size": 1024, "browser_download_url": "https://example/shot.png"}
|
||||
]
|
||||
}`))
|
||||
default:
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
})
|
||||
server := httptest.NewServer(handler)
|
||||
defer server.Close()
|
||||
|
||||
origHost, origToken, origVersion := flag.Host, flag.Token, flag.Version
|
||||
flag.Host, flag.Token, flag.Version = server.URL, "", "test"
|
||||
defer func() { flag.Host, flag.Token, flag.Version = origHost, origToken, origVersion }()
|
||||
|
||||
req := mcp.CallToolRequest{Params: mcp.CallToolParams{Arguments: map[string]any{
|
||||
"owner": owner, "repo": repo, "index": float64(42),
|
||||
}}}
|
||||
res, err := getIssueByIndexFn(context.Background(), req)
|
||||
if err != nil {
|
||||
t.Fatalf("getIssueByIndexFn() error = %v", err)
|
||||
}
|
||||
if res.IsError {
|
||||
t.Fatalf("unexpected error result: %v", res.Content)
|
||||
}
|
||||
body := res.Content[0].(mcp.TextContent).Text
|
||||
if !strings.Contains(body, `[shot.png](https://example/shot.png)`) {
|
||||
t.Fatalf("expected attachment markdown inlined in body, got: %s", body)
|
||||
}
|
||||
if strings.Contains(body, `"attachments"`) {
|
||||
t.Fatalf("attachments should be inlined into body, not a separate field: %s", body)
|
||||
}
|
||||
}
|
||||
|
||||
func Test_getIssueCommentsByIndexFn_includesAttachments(t *testing.T) {
|
||||
const (
|
||||
owner = "octo"
|
||||
repo = "demo"
|
||||
)
|
||||
|
||||
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/api/v1/version":
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write([]byte(`{"version":"1.12.0"}`))
|
||||
case fmt.Sprintf("/api/v1/repos/%s/%s/issues/7/comments", owner, repo):
|
||||
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": []}
|
||||
]`))
|
||||
default:
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
})
|
||||
server := httptest.NewServer(handler)
|
||||
defer server.Close()
|
||||
|
||||
origHost, origToken, origVersion := flag.Host, flag.Token, flag.Version
|
||||
flag.Host, flag.Token, flag.Version = server.URL, "", "test"
|
||||
defer func() { flag.Host, flag.Token, flag.Version = origHost, origToken, origVersion }()
|
||||
|
||||
req := mcp.CallToolRequest{Params: mcp.CallToolParams{Arguments: map[string]any{
|
||||
"owner": owner, "repo": repo, "index": float64(7),
|
||||
}}}
|
||||
res, err := getIssueCommentsByIndexFn(context.Background(), req)
|
||||
if err != nil {
|
||||
t.Fatalf("getIssueCommentsByIndexFn() error = %v", err)
|
||||
}
|
||||
if res.IsError {
|
||||
t.Fatalf("unexpected error result: %v", res.Content)
|
||||
}
|
||||
body := res.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, `"attachments"`) {
|
||||
t.Fatalf("attachments should be inlined into body, not a separate field: %s", body)
|
||||
}
|
||||
}
|
||||
|
||||
+21
-8
@@ -1,6 +1,9 @@
|
||||
package issue
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
gitea_sdk "code.gitea.io/sdk/gitea"
|
||||
)
|
||||
|
||||
@@ -37,6 +40,24 @@ func labelNames(labels []*gitea_sdk.Label) []string {
|
||||
return out
|
||||
}
|
||||
|
||||
func bodyWithAttachments(body string, atts []*gitea_sdk.Attachment) string {
|
||||
links := make([]string, 0, len(atts))
|
||||
for _, a := range atts {
|
||||
if a == nil || a.DownloadURL == "" {
|
||||
continue
|
||||
}
|
||||
links = append(links, fmt.Sprintf("[%s](%s)", a.Name, a.DownloadURL))
|
||||
}
|
||||
if len(links) == 0 {
|
||||
return body
|
||||
}
|
||||
joined := strings.Join(links, "\n")
|
||||
if body == "" {
|
||||
return joined
|
||||
}
|
||||
return body + "\n\n" + joined
|
||||
}
|
||||
|
||||
func slimIssue(i *gitea_sdk.Issue) map[string]any {
|
||||
if i == nil {
|
||||
return nil
|
||||
@@ -119,14 +140,6 @@ func slimComment(c *gitea_sdk.Comment) map[string]any {
|
||||
}
|
||||
}
|
||||
|
||||
func slimComments(comments []*gitea_sdk.Comment) []map[string]any {
|
||||
out := make([]map[string]any, 0, len(comments))
|
||||
for _, c := range comments {
|
||||
out = append(out, slimComment(c))
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
func slimLabels(labels []*gitea_sdk.Label) []map[string]any {
|
||||
out := make([]map[string]any, 0, len(labels))
|
||||
for _, l := range labels {
|
||||
|
||||
@@ -40,6 +40,29 @@ func TestSlimIssue(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestBodyWithAttachments(t *testing.T) {
|
||||
atts := []*gitea_sdk.Attachment{
|
||||
{Name: "shot.png", DownloadURL: "https://example/shot.png"},
|
||||
{Name: "log.txt", DownloadURL: "https://example/log.txt"},
|
||||
}
|
||||
got := bodyWithAttachments("see attached", atts)
|
||||
want := "see attached\n\n[shot.png](https://example/shot.png)\n[log.txt](https://example/log.txt)"
|
||||
if got != want {
|
||||
t.Errorf("got %q, want %q", got, want)
|
||||
}
|
||||
|
||||
if got := bodyWithAttachments("only body", nil); got != "only body" {
|
||||
t.Errorf("nil attachments should return body unchanged, got %q", got)
|
||||
}
|
||||
if got := bodyWithAttachments("", atts); got != "[shot.png](https://example/shot.png)\n[log.txt](https://example/log.txt)" {
|
||||
t.Errorf("empty body should drop separator, got %q", got)
|
||||
}
|
||||
skipped := []*gitea_sdk.Attachment{nil, {Name: "noop", DownloadURL: ""}}
|
||||
if got := bodyWithAttachments("body", skipped); got != "body" {
|
||||
t.Errorf("nil/empty-URL attachments should be skipped, got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSlimIssues_ListIsSlimmer(t *testing.T) {
|
||||
i := &gitea_sdk.Issue{
|
||||
Index: 1,
|
||||
|
||||
Reference in New Issue
Block a user