mirror of
https://gitea.com/gitea/gitea-mcp.git
synced 2026-08-27 18:47:44 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4e62d158cb |
@@ -31,5 +31,7 @@ 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,6 +10,8 @@
|
|||||||
|
|
||||||
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,6 +10,8 @@
|
|||||||
|
|
||||||
可从 [发布页面](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,6 +10,8 @@
|
|||||||
|
|
||||||
可從 [發布頁面](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
|
||||||
|
|||||||
@@ -0,0 +1,29 @@
|
|||||||
|
# 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.
|
||||||
@@ -49,7 +49,6 @@ var (
|
|||||||
tool.Array("milestones", tool.Description("milestone name or ID filter"), tool.Items(map[string]any{"type": "string"})),
|
tool.Array("milestones", tool.Description("milestone name or ID filter"), tool.Items(map[string]any{"type": "string"})),
|
||||||
tool.String("since", tool.Description("updated after ISO 8601")),
|
tool.String("since", tool.Description("updated after ISO 8601")),
|
||||||
tool.String("before", tool.Description("updated before ISO 8601")),
|
tool.String("before", tool.Description("updated before ISO 8601")),
|
||||||
tool.String("assigned_by", tool.Description("filter by the user who assigned the issue")),
|
|
||||||
tool.Number("page", tool.Description(params.PageDesc), tool.Default(1)),
|
tool.Number("page", tool.Description(params.PageDesc), tool.Default(1)),
|
||||||
tool.Number("per_page", tool.Description(params.PaginationDesc), tool.Default(30)),
|
tool.Number("per_page", tool.Description(params.PaginationDesc), tool.Default(30)),
|
||||||
)
|
)
|
||||||
@@ -205,9 +204,6 @@ func listRepoIssuesFn(ctx context.Context, args map[string]any) (*mcp.CallToolRe
|
|||||||
if t := params.GetOptionalTime(args, "before"); t != nil {
|
if t := params.GetOptionalTime(args, "before"); t != nil {
|
||||||
opt.Before = *t
|
opt.Before = *t
|
||||||
}
|
}
|
||||||
if assignedBy, ok := args["assigned_by"].(string); ok {
|
|
||||||
opt.AssignedBy = assignedBy
|
|
||||||
}
|
|
||||||
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))
|
||||||
|
|||||||
@@ -61,13 +61,12 @@ func Test_listRepoIssuesFn_filters(t *testing.T) {
|
|||||||
}()
|
}()
|
||||||
|
|
||||||
args := map[string]any{
|
args := map[string]any{
|
||||||
"owner": owner,
|
"owner": owner,
|
||||||
"repo": repo,
|
"repo": repo,
|
||||||
"type": "issues",
|
"type": "issues",
|
||||||
"labels": []any{"bug", "enhancement"},
|
"labels": []any{"bug", "enhancement"},
|
||||||
"milestones": []any{"v1.0", "2"},
|
"milestones": []any{"v1.0", "2"},
|
||||||
"since": "2026-01-01T00:00:00Z",
|
"since": "2026-01-01T00:00:00Z",
|
||||||
"assigned_by": "octocat",
|
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err := listRepoIssuesFn(context.Background(), args)
|
_, err := listRepoIssuesFn(context.Background(), args)
|
||||||
@@ -90,9 +89,6 @@ func Test_listRepoIssuesFn_filters(t *testing.T) {
|
|||||||
if !strings.Contains(gotQuery, "type=issues") {
|
if !strings.Contains(gotQuery, "type=issues") {
|
||||||
t.Fatalf("expected type query param, got %s", gotQuery)
|
t.Fatalf("expected type query param, got %s", gotQuery)
|
||||||
}
|
}
|
||||||
if !strings.Contains(gotQuery, "assigned_by=octocat") {
|
|
||||||
t.Fatalf("expected assigned_by query param, got %s", gotQuery)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func Test_listRepoIssuesFn_includesMilestone(t *testing.T) {
|
func Test_listRepoIssuesFn_includesMilestone(t *testing.T) {
|
||||||
@@ -142,52 +138,6 @@ func Test_listRepoIssuesFn_includesMilestone(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func Test_listRepoIssuesFn_includesAssignees(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", owner, repo):
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
_, _ = w.Write([]byte(`{"private":false}`))
|
|
||||||
case fmt.Sprintf("/api/v1/repos/%s/%s/issues", owner, repo):
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
_, _ = w.Write([]byte(`[
|
|
||||||
{"number": 1, "title": "with assignees", "state": "open", "assignees": [{"login": "octocat"}]}
|
|
||||||
]`))
|
|
||||||
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 }()
|
|
||||||
|
|
||||||
args := map[string]any{
|
|
||||||
"owner": owner, "repo": repo,
|
|
||||||
}
|
|
||||||
res, err := listRepoIssuesFn(context.Background(), args)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("listRepoIssuesFn() 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, `"assignees"`) || !strings.Contains(body, `"octocat"`) {
|
|
||||||
t.Fatalf("expected assignees in list output, got: %s", body)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func Test_createIssueFn_labels(t *testing.T) {
|
func Test_createIssueFn_labels(t *testing.T) {
|
||||||
const (
|
const (
|
||||||
owner = "octo"
|
owner = "octo"
|
||||||
|
|||||||
@@ -63,9 +63,6 @@ func slimIssues(issues []*gitea_sdk.Issue) []map[string]any {
|
|||||||
if len(i.Labels) > 0 {
|
if len(i.Labels) > 0 {
|
||||||
m["labels"] = slim.LabelNames(i.Labels)
|
m["labels"] = slim.LabelNames(i.Labels)
|
||||||
}
|
}
|
||||||
if len(i.Assignees) > 0 {
|
|
||||||
m["assignees"] = slim.UserLogins(i.Assignees)
|
|
||||||
}
|
|
||||||
if i.Milestone != nil {
|
if i.Milestone != nil {
|
||||||
m["milestone"] = map[string]any{
|
m["milestone"] = map[string]any{
|
||||||
"id": i.Milestone.ID,
|
"id": i.Milestone.ID,
|
||||||
|
|||||||
@@ -22,6 +22,38 @@ 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