mirror of
https://gitea.com/gitea/gitea-mcp.git
synced 2026-08-28 02:57:44 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2ffb16ba1e |
@@ -31,7 +31,5 @@ USER nonroot:nonroot
|
|||||||
|
|
||||||
LABEL org.opencontainers.image.version="${VERSION}"
|
LABEL org.opencontainers.image.version="${VERSION}"
|
||||||
LABEL org.opencontainers.image.source="https://gitea.com/gitea/gitea-mcp"
|
LABEL org.opencontainers.image.source="https://gitea.com/gitea/gitea-mcp"
|
||||||
LABEL org.opencontainers.image.title="Gitea MCP Server"
|
|
||||||
LABEL org.opencontainers.image.description="Model Context Protocol server connecting Gitea instances to MCP clients, published as docker.gitea.com/gitea-mcp-server."
|
|
||||||
|
|
||||||
CMD ["/app/gitea-mcp"]
|
CMD ["/app/gitea-mcp"]
|
||||||
|
|||||||
@@ -10,8 +10,6 @@
|
|||||||
|
|
||||||
Download a binary from the [releases page](https://gitea.com/gitea/gitea-mcp/releases) and put it in your `PATH`, use the `docker.gitea.com/gitea-mcp-server` image, or build from source into `$GOPATH/bin` with `make` and Go 1.26 or later:
|
Download a binary from the [releases page](https://gitea.com/gitea/gitea-mcp/releases) and put it in your `PATH`, use the `docker.gitea.com/gitea-mcp-server` image, or build from source into `$GOPATH/bin` with `make` and Go 1.26 or later:
|
||||||
|
|
||||||
> The published Docker image is `docker.gitea.com/gitea-mcp-server`, which does not match the `gitea-mcp` repository name. This is a known mismatch, tracked in [issue #181](https://gitea.com/gitea/gitea-mcp/issues/181); the image name stays as-is for now to avoid breaking existing installs. See [docs/adr/docker-image-naming.md](docs/adr/docker-image-naming.md) for details.
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://gitea.com/gitea/gitea-mcp.git
|
git clone https://gitea.com/gitea/gitea-mcp.git
|
||||||
cd gitea-mcp
|
cd gitea-mcp
|
||||||
|
|||||||
@@ -10,8 +10,6 @@
|
|||||||
|
|
||||||
可从 [发布页面](https://gitea.com/gitea/gitea-mcp/releases) 下载二进制文件并放入 `PATH`,或使用 `docker.gitea.com/gitea-mcp-server` 镜像,也可用 `make` 和 Go 1.26 及以上从源码构建到 `$GOPATH/bin`:
|
可从 [发布页面](https://gitea.com/gitea/gitea-mcp/releases) 下载二进制文件并放入 `PATH`,或使用 `docker.gitea.com/gitea-mcp-server` 镜像,也可用 `make` 和 Go 1.26 及以上从源码构建到 `$GOPATH/bin`:
|
||||||
|
|
||||||
> 已发布的 Docker 镜像名为 `docker.gitea.com/gitea-mcp-server`,与 `gitea-mcp` 仓库名不一致。这是 [issue #181](https://gitea.com/gitea/gitea-mcp/issues/181) 中记录的已知不一致,为避免破坏现有安装,镜像名暂不改动。详见 [docs/adr/docker-image-naming.md](docs/adr/docker-image-naming.md)。
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://gitea.com/gitea/gitea-mcp.git
|
git clone https://gitea.com/gitea/gitea-mcp.git
|
||||||
cd gitea-mcp
|
cd gitea-mcp
|
||||||
|
|||||||
@@ -10,8 +10,6 @@
|
|||||||
|
|
||||||
可從 [發布頁面](https://gitea.com/gitea/gitea-mcp/releases) 下載二進位檔並放入 `PATH`,或使用 `docker.gitea.com/gitea-mcp-server` 映像檔,也可用 `make` 與 Go 1.26 以上從原始碼建置到 `$GOPATH/bin`:
|
可從 [發布頁面](https://gitea.com/gitea/gitea-mcp/releases) 下載二進位檔並放入 `PATH`,或使用 `docker.gitea.com/gitea-mcp-server` 映像檔,也可用 `make` 與 Go 1.26 以上從原始碼建置到 `$GOPATH/bin`:
|
||||||
|
|
||||||
> 已發布的 Docker 映像檔名稱為 `docker.gitea.com/gitea-mcp-server`,與 `gitea-mcp` 倉庫名稱不一致。這是 [issue #181](https://gitea.com/gitea/gitea-mcp/issues/181) 中記錄的已知不一致,為避免破壞現有安裝,映像檔名稱暫不變更。詳見 [docs/adr/docker-image-naming.md](docs/adr/docker-image-naming.md)。
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://gitea.com/gitea/gitea-mcp.git
|
git clone https://gitea.com/gitea/gitea-mcp.git
|
||||||
cd gitea-mcp
|
cd gitea-mcp
|
||||||
|
|||||||
@@ -1,29 +0,0 @@
|
|||||||
# Docker image naming mismatch (issue #181)
|
|
||||||
|
|
||||||
## Current state
|
|
||||||
|
|
||||||
The project repository is `gitea.com/gitea/gitea-mcp`, but the Docker image is
|
|
||||||
published as `docker.gitea.com/gitea-mcp-server`. This mismatch was raised in
|
|
||||||
[issue #181](https://gitea.com/gitea/gitea-mcp/issues/181).
|
|
||||||
|
|
||||||
## Maintainers' direction
|
|
||||||
|
|
||||||
Per the issue discussion, the maintainers' preferred long-term name is
|
|
||||||
`gitea/mcp-server`, matching the naming scheme used by `gitea/act_runner`
|
|
||||||
(published as a `runner`-style short name) and by comparable projects such as
|
|
||||||
`github/github-mcp-server`. The name `mcp-server` was preferred over
|
|
||||||
`gitea-mcp-server` because the repository is primarily run as a local client
|
|
||||||
process, not a traditional long-running server.
|
|
||||||
|
|
||||||
## Decision
|
|
||||||
|
|
||||||
No rename has happened yet; the discussion was explicitly left open in the
|
|
||||||
issue. The current image name, `docker.gitea.com/gitea-mcp-server`, remains in
|
|
||||||
use so that existing user configurations and documentation keep working.
|
|
||||||
`org.opencontainers.image.title` and `org.opencontainers.image.description`
|
|
||||||
labels were added to the `Dockerfile` to make the image self-describing
|
|
||||||
regardless of the tag it is published under.
|
|
||||||
|
|
||||||
If the image is renamed in the future, update the `docker.gitea.com/gitea-mcp-server`
|
|
||||||
references across `README.md`, `README.zh-cn.md` and `README.zh-tw.md` together
|
|
||||||
with this document.
|
|
||||||
+41
-2
@@ -20,6 +20,13 @@ import (
|
|||||||
|
|
||||||
var Tool = tool.New("pull_request")
|
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 (
|
const (
|
||||||
ListRepoPullRequestsToolName = "list_pull_requests"
|
ListRepoPullRequestsToolName = "list_pull_requests"
|
||||||
PullRequestReadToolName = "pull_request_read"
|
PullRequestReadToolName = "pull_request_read"
|
||||||
@@ -43,9 +50,9 @@ var (
|
|||||||
|
|
||||||
PullRequestReadTool = tool.NewDefinition(
|
PullRequestReadTool = tool.NewDefinition(
|
||||||
PullRequestReadToolName,
|
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"),
|
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("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.Number("pull_number", tool.Required()),
|
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)
|
return getPullRequestReviewFn(ctx, args)
|
||||||
case "get_review_comments":
|
case "get_review_comments":
|
||||||
return listPullRequestReviewCommentsFn(ctx, args)
|
return listPullRequestReviewCommentsFn(ctx, args)
|
||||||
|
case "get_comments":
|
||||||
|
return listPullRequestCommentsFn(ctx, args)
|
||||||
default:
|
default:
|
||||||
return to.ErrorResult(fmt.Errorf("unknown method: %s", method))
|
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))
|
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) {
|
func createPullRequestReviewFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
|
||||||
owner, err := params.GetString(args, "owner")
|
owner, err := params.GetString(args, "owner")
|
||||||
if err != nil {
|
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) {
|
func Test_reopenPullRequestFn(t *testing.T) {
|
||||||
const (
|
const (
|
||||||
owner = "octo"
|
owner = "octo"
|
||||||
|
|||||||
@@ -164,3 +164,17 @@ func slimReviewComments(comments []*gitea_sdk.PullReviewComment) []map[string]an
|
|||||||
}
|
}
|
||||||
return out
|
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,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -22,38 +22,6 @@ var readmeAccessLabels = map[string]map[string]string{
|
|||||||
"../README.zh-tw.md": {"讀取": "read", "寫入": "write"},
|
"../README.zh-tw.md": {"讀取": "read", "寫入": "write"},
|
||||||
}
|
}
|
||||||
|
|
||||||
// publishedDockerImage is the image name published for this project. See
|
|
||||||
// docs/adr/docker-image-naming.md for why it differs from the repository name.
|
|
||||||
const publishedDockerImage = "docker.gitea.com/gitea-mcp-server"
|
|
||||||
|
|
||||||
// dockerImageReference matches any docker.gitea.com/<name> image reference so
|
|
||||||
// stray typos or partial renames in the README files can be caught.
|
|
||||||
var dockerImageReference = regexp.MustCompile(`docker\.gitea\.com/[a-zA-Z0-9._-]+`)
|
|
||||||
|
|
||||||
// TestReadmeDockerImageReferencesAreConsistent ensures every README mentions
|
|
||||||
// the same, currently published Docker image name. A partial rename, where
|
|
||||||
// one example is updated but another is missed, would otherwise leave users
|
|
||||||
// copying a command that pulls a nonexistent image.
|
|
||||||
func TestReadmeDockerImageReferencesAreConsistent(t *testing.T) {
|
|
||||||
for _, path := range []string{"../README.md", "../README.zh-cn.md", "../README.zh-tw.md"} {
|
|
||||||
t.Run(filepath.Base(path), func(t *testing.T) {
|
|
||||||
content, err := os.ReadFile(path)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
references := dockerImageReference.FindAllString(string(content), -1)
|
|
||||||
if len(references) == 0 {
|
|
||||||
t.Fatalf("no docker.gitea.com image reference found in %s", path)
|
|
||||||
}
|
|
||||||
for _, ref := range references {
|
|
||||||
if ref != publishedDockerImage {
|
|
||||||
t.Errorf("found image reference %q in %s, want %q", ref, path, publishedDockerImage)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// toolInfo is what TestReadmeToolTables tracks per tool, both as registered
|
// toolInfo is what TestReadmeToolTables tracks per tool, both as registered
|
||||||
// in code and as documented in a README, so the two can be compared.
|
// in code and as documented in a README, so the two can be compared.
|
||||||
type toolInfo struct {
|
type toolInfo struct {
|
||||||
|
|||||||
Reference in New Issue
Block a user