mirror of
https://gitea.com/gitea/gitea-mcp.git
synced 2026-08-28 19:17: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.
|
||||||
@@ -1,98 +0,0 @@
|
|||||||
package actions
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"net/url"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"gitea.com/gitea/gitea-mcp/pkg/flag"
|
|
||||||
|
|
||||||
"github.com/modelcontextprotocol/go-sdk/mcp"
|
|
||||||
)
|
|
||||||
|
|
||||||
func Test_listPullRequestActionRunsFn(t *testing.T) {
|
|
||||||
const (
|
|
||||||
owner = "octo"
|
|
||||||
repo = "demo"
|
|
||||||
pullNumber = 42
|
|
||||||
headSHA = "abc123"
|
|
||||||
)
|
|
||||||
|
|
||||||
var gotRunsQuery string
|
|
||||||
|
|
||||||
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
switch r.URL.Path {
|
|
||||||
case fmt.Sprintf("/api/v1/repos/%s/%s/pulls/%d", owner, repo, pullNumber):
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
_, _ = w.Write(fmt.Appendf(nil, `{"number":%d,"head":{"sha":"%s"}}`, pullNumber, headSHA))
|
|
||||||
case fmt.Sprintf("/api/v1/repos/%s/%s/actions/runs", owner, repo):
|
|
||||||
gotRunsQuery = r.URL.RawQuery
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
_, _ = w.Write([]byte(`{"total_count":1,"workflow_runs":[{"id":9,"name":"CI","status":"success"}]}`))
|
|
||||||
default:
|
|
||||||
http.NotFound(w, r)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
server := httptest.NewServer(handler)
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
origHost := flag.Host
|
|
||||||
origToken := flag.Token
|
|
||||||
flag.Host = server.URL
|
|
||||||
flag.Token = ""
|
|
||||||
defer func() {
|
|
||||||
flag.Host = origHost
|
|
||||||
flag.Token = origToken
|
|
||||||
}()
|
|
||||||
|
|
||||||
args := map[string]any{
|
|
||||||
"owner": owner,
|
|
||||||
"repo": repo,
|
|
||||||
"pull_number": float64(pullNumber),
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := listPullRequestActionRunsFn(context.Background(), args)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("listPullRequestActionRunsFn() error = %v", err)
|
|
||||||
}
|
|
||||||
if result.IsError {
|
|
||||||
t.Fatalf("listPullRequestActionRunsFn() returned error result: %+v", result)
|
|
||||||
}
|
|
||||||
|
|
||||||
if gotRunsQuery == "" {
|
|
||||||
t.Fatalf("expected actions/runs to be called")
|
|
||||||
}
|
|
||||||
values, err := url.ParseQuery(gotRunsQuery)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse actions/runs query: %v", err)
|
|
||||||
}
|
|
||||||
if got := values.Get("head_sha"); got != headSHA {
|
|
||||||
t.Fatalf("actions/runs head_sha = %q, want %q", got, headSHA)
|
|
||||||
}
|
|
||||||
|
|
||||||
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])
|
|
||||||
}
|
|
||||||
|
|
||||||
var parsed struct {
|
|
||||||
WorkflowRuns []map[string]any `json:"workflow_runs"`
|
|
||||||
}
|
|
||||||
if err := json.Unmarshal([]byte(textContent.Text), &parsed); err != nil {
|
|
||||||
t.Fatalf("unmarshal result text: %v", err)
|
|
||||||
}
|
|
||||||
if len(parsed.WorkflowRuns) != 1 {
|
|
||||||
t.Fatalf("expected 1 run, got %d", len(parsed.WorkflowRuns))
|
|
||||||
}
|
|
||||||
if got := parsed.WorkflowRuns[0]["name"]; got != "CI" {
|
|
||||||
t.Fatalf("run name = %v, want %q", got, "CI")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -29,16 +29,15 @@ 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_pr_runs", "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("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')")),
|
||||||
tool.Number("run_id", tool.Description("for 'get_run'/'list_run_jobs'/'list_run_artifacts'")),
|
tool.Number("run_id", tool.Description("for 'get_run'/'list_run_jobs'/'list_run_artifacts'")),
|
||||||
tool.Number("pull_number", tool.Description("pull request number (for 'list_pr_runs')")),
|
|
||||||
tool.Number("job_id", tool.Description("for 'get_job'/log methods")),
|
tool.Number("job_id", tool.Description("for 'get_job'/log methods")),
|
||||||
tool.Number("artifact_id", tool.Description("for 'get_artifact'/'download_artifact'")),
|
tool.Number("artifact_id", tool.Description("for 'get_artifact'/'download_artifact'")),
|
||||||
tool.String("artifact_name", tool.Description("name filter for 'list_artifacts'/'list_run_artifacts'")),
|
tool.String("artifact_name", tool.Description("name filter for 'list_artifacts'/'list_run_artifacts'")),
|
||||||
tool.String("status", tool.Description("filter for 'list_runs'/'list_pr_runs'/'list_jobs'")),
|
tool.String("status", tool.Description("filter for 'list_runs'/'list_jobs'")),
|
||||||
tool.Number("tail_lines", tool.Description("log tail lines"), tool.Default(200), tool.Minimum(1)),
|
tool.Number("tail_lines", tool.Description("log tail lines"), tool.Default(200), tool.Minimum(1)),
|
||||||
tool.Number("max_bytes", tool.Description("max log bytes"), tool.Default(65536), tool.Minimum(1024)),
|
tool.Number("max_bytes", tool.Description("max log bytes"), tool.Default(65536), tool.Minimum(1024)),
|
||||||
tool.String("output_path", tool.Description("for 'download_job_log'/'download_artifact'")),
|
tool.String("output_path", tool.Description("for 'download_job_log'/'download_artifact'")),
|
||||||
@@ -79,8 +78,6 @@ func runReadFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, e
|
|||||||
return listRepoActionRunsFn(ctx, args)
|
return listRepoActionRunsFn(ctx, args)
|
||||||
case "get_run":
|
case "get_run":
|
||||||
return getRepoActionRunFn(ctx, args)
|
return getRepoActionRunFn(ctx, args)
|
||||||
case "list_pr_runs":
|
|
||||||
return listPullRequestActionRunsFn(ctx, args)
|
|
||||||
case "list_jobs":
|
case "list_jobs":
|
||||||
return listRepoActionJobsFn(ctx, args)
|
return listRepoActionJobsFn(ctx, args)
|
||||||
case "list_run_jobs":
|
case "list_run_jobs":
|
||||||
@@ -300,61 +297,6 @@ func getRepoActionRunFn(ctx context.Context, args map[string]any) (*mcp.CallTool
|
|||||||
return to.TextResult(slimActionRun(result))
|
return to.TextResult(slimActionRun(result))
|
||||||
}
|
}
|
||||||
|
|
||||||
func listPullRequestActionRunsFn(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"))
|
|
||||||
}
|
|
||||||
page, pageSize := params.GetPagination(args, 30)
|
|
||||||
statusFilter, _ := args["status"].(string)
|
|
||||||
|
|
||||||
var pull struct {
|
|
||||||
Head struct {
|
|
||||||
SHA string `json:"sha"`
|
|
||||||
} `json:"head"`
|
|
||||||
}
|
|
||||||
err = doJSONWithFallback(ctx, "GET",
|
|
||||||
[]string{
|
|
||||||
fmt.Sprintf("repos/%s/%s/pulls/%d", url.PathEscape(owner), url.PathEscape(repo), pullNumber),
|
|
||||||
},
|
|
||||||
nil, nil, &pull,
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
return to.ErrorResult(fmt.Errorf("get pull request err: %v", err))
|
|
||||||
}
|
|
||||||
if pull.Head.SHA == "" {
|
|
||||||
return to.ErrorResult(fmt.Errorf("pull request %d has no head sha", pullNumber))
|
|
||||||
}
|
|
||||||
|
|
||||||
query := url.Values{}
|
|
||||||
query.Set("head_sha", pull.Head.SHA)
|
|
||||||
query.Set("page", strconv.Itoa(page))
|
|
||||||
query.Set("limit", strconv.Itoa(pageSize))
|
|
||||||
if statusFilter != "" {
|
|
||||||
query.Set("status", statusFilter)
|
|
||||||
}
|
|
||||||
|
|
||||||
var result 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 to.ErrorResult(fmt.Errorf("list pull request action runs err: %v", err))
|
|
||||||
}
|
|
||||||
return to.TextResult(slimActionRuns(result))
|
|
||||||
}
|
|
||||||
|
|
||||||
func cancelRepoActionRunFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
|
func cancelRepoActionRunFn(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 {
|
||||||
|
|||||||
@@ -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