Add Dockerfile

Reviewed-on: https://gitea.com/gitea/gitea-mcp/pulls/16
Co-authored-by: hiifong <f@ilo.nz>
Co-committed-by: hiifong <f@ilo.nz>

.gitea/workflows/release-latest.yml

@@ -0,0 +1,51 @@
+name: release-nightly
+
+on:
+  push:
+    branches: [main]
+    tags:
+      - "*"
+
+jobs:
+  release-image:
+    runs-on: ubuntu-latest
+    env:
+      DOCKER_ORG: gitea
+      DOCKER_LATEST: nightly
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # all history for all branches and tags
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker BuildX
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Get Meta
+        id: meta
+        run: |
+          echo REPO_NAME=$(echo ${GITHUB_REPOSITORY} | awk -F"/" '{print $2}') >> $GITHUB_OUTPUT
+          echo REPO_VERSION=$(shell git describe --tags --always | sed 's/-/+/' | sed 's/^v//') >> $GITHUB_OUTPUT
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: |
+            linux/amd64
+            linux/arm64
+          push: true
+          tags: |
+            ${{ env.DOCKER_ORG }}/${{ steps.meta.outputs.REPO_NAME }}-server:${{ env.DOCKER_LATEST }}
+          build-args: |
+            VERSION=${{ steps.meta.outputs.REPO_VERSION }}

.gitea/workflows/release-tag.yml

@@ -36,3 +36,44 @@ jobs:
           files: |-
             bin/**
           token: '${{secrets.RELEASE_TOKEN}}'
+  release-image:
+    runs-on: ubuntu-latest
+    env:
+      DOCKER_ORG: gitea
+      DOCKER_LATEST: latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # all history for all branches and tags
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker BuildX
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Get Meta
+        id: meta
+        run: |
+          echo REPO_NAME=$(echo ${GITHUB_REPOSITORY} | awk -F"/" '{print $2}') >> $GITHUB_OUTPUT
+          echo REPO_VERSION=${GITHUB_REF_NAME#v} >> $GITHUB_OUTPUT
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: |
+            linux/amd64
+            linux/arm64
+          push: true
+          tags: |
+            ${{ env.DOCKER_ORG }}/${{ steps.meta.outputs.REPO_NAME }}-server:${{ steps.meta.outputs.REPO_VERSION }}
+            ${{ env.DOCKER_ORG }}/${{ steps.meta.outputs.REPO_NAME }}-server:${{ env.DOCKER_LATEST }}

Dockerfile

@@ -0,0 +1,18 @@
+FROM golang:1.24-alpine AS builder
+
+ARG VERSION
+
+WORKDIR /build
+
+COPY . .
+RUN go mod download
+
+RUN CGO_ENABLED=0 go build -ldflags="-s -w -X main.version=${VERSION}" -o gitea-mcp
+
+FROM scratch
+
+WORKDIR /app
+
+COPY --from=builder /build/gitea-mcp .
+
+CMD ["./gitea-mcp", "-t", "stdio"]

README.md

@@ -2,13 +2,64 @@
 
 **Gitea MCP Server** is an integration plugin designed to connect Gitea with Model Context Protocol (MCP) systems. This allows for seamless command execution and repository management through an MCP-compatible chat interface.
 
-## 🚧Installation
+[![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=gitea&inputs=[{%22id%22:%22gitea_token%22,%22type%22:%22promptString%22,%22description%22:%22Gitea%20Personal%20Access%20Token%22,%22password%22:true}]&config={%22command%22:%22docker%22,%22args%22:[%22run%22,%22-i%22,%22--rm%22,%22-e%22,%22GITEA_ACCESS_TOKEN%22,%22docker.gitea.com/gitea-mcp-server%22],%22env%22:{%22GITEA_ACCESS_TOKEN%22:%22${input:gitea_token}%22}}) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=gitea&inputs=[{%22id%22:%22gitea_token%22,%22type%22:%22promptString%22,%22description%22:%22Gitea%20Personal%20Access%20Token%22,%22password%22:true}]&config={%22command%22:%22docker%22,%22args%22:[%22run%22,%22-i%22,%22--rm%22,%22-e%22,%22GITEA_ACCESS_TOKEN%22,%22docker.gitea.com/gitea-mcp-server%22],%22env%22:{%22GITEA_ACCESS_TOKEN%22:%22${input:gitea_token}%22}}&quality=insiders)
 
-### 📥Download the official binary release
+## What is Gitea?
+
+Gitea is a community-managed lightweight code hosting solution written in Go. It is published under the MIT license. Gitea provides Git hosting including a repository viewer, issue tracking, pull requests, and more.
+
+## What is MCP?
+
+Model Context Protocol (MCP) is a protocol that allows for the integration of various tools and systems through a chat interface. It enables seamless command execution and management of repositories, users, and other resources.
+
+## 🚧 Installation
+
+### Usage with VS Code
+
+For quick installation, use one of the one-click install buttons at the top of this README.
+
+For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`.
+
+Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others.
+
+> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file.
+
+```json
+{
+  "mcp": {
+    "inputs": [
+      {
+        "type": "promptString",
+        "id": "gitea_token",
+        "description": "Gitea Personal Access Token",
+        "password": true
+      }
+    ],
+    "servers": {
+      "github": {
+        "command": "docker",
+        "args": [
+          "run",
+          "-i",
+          "--rm",
+          "-e",
+          "GITEA_ACCESS_TOKEN",
+          "docker.gitea.com/gitea-mcp-server"
+        ],
+        "env": {
+          "GITEA_ACCESS_TOKEN": "${input:gitea_token}"
+        }
+      }
+    }
+  }
+}
+```
+
+### 📥 Download the official binary release
 
 You can download the official release from [here](https://gitea.com/gitea/gitea-mcp/releases).
 
-### 🔧Build from Source
+### 🔧 Build from Source
 
 You can download the source code by cloning the repository using Git:
 
@@ -27,7 +78,7 @@ Then run:
 make build
 ```
 
-### 📁Add to PATH
+### 📁 Add to PATH
 
 After building, copy the binary gitea-mcp to a directory included in your system's PATH. For example:
 
@@ -35,7 +86,7 @@ After building, copy the binary gitea-mcp to a directory included in your system
 cp gitea-mcp /usr/local/bin/
 ```
 
-## 🚀Usage
+## 🚀 Usage
 
 This example is for Cursor, you can also use plugins in VSCode.
 To configure the MCP server for Gitea, add the following to your MCP configuration file:
@@ -48,8 +99,10 @@ To configure the MCP server for Gitea, add the following to your MCP configurati
     "gitea": {
       "command": "gitea-mcp",
       "args": [
-        "-t", "stdio",
+        "-t",
-        "--host", "https://gitea.com"
+        "stdio",
+        "--host",
+        "https://gitea.com"
         // "--token", "<your personal access token>"
       ],
       "env": {
@@ -73,6 +126,8 @@ To configure the MCP server for Gitea, add the following to your MCP configurati
 }
 ```
 
+**Default log path**: `$HOME/.gitea-mcp/gitea-mcp.log`
+
 > [!NOTE]
 > You can provide your Gitea host and access token either as command-line arguments or environment variables.
 > Command-line arguments have the highest priority
@@ -83,37 +138,37 @@ Once everything is set up, try typing the following in your MCP-compatible chatb
 list all my repositories
 ```
 
-## ✅Available Tools
+## ✅ Available Tools
 
 The Gitea MCP Server supports the following tools:
 
 |             Tool             |    Scope     |                      Description                      |
-|:------:|:-------:|:------------:|
+| :--------------------------: | :----------: | :---------------------------------------------------: |
-|get_my_user_info|User|Get the information of the authenticated user|
+|       get_my_user_info       |     User     |     Get the information of the authenticated user     |
-|create_repo|Repository|Create a new repository|
+|         create_repo          |  Repository  |                Create a new repository                |
-|fork_repo|Repository|Fork a repository|
+|          fork_repo           |  Repository  |                   Fork a repository                   |
-|list_my_repos|Repository|List all repositories owned by the authenticated user|
+|        list_my_repos         |  Repository  | List all repositories owned by the authenticated user |
-|create_branch|Branch|Create a new branch|
+|        create_branch         |    Branch    |                  Create a new branch                  |
-|delete_branch|Branch|Delete a branch|
+|        delete_branch         |    Branch    |                    Delete a branch                    |
-|list_branches|Branch|List all branches in a repository|
+|        list_branches         |    Branch    |           List all branches in a repository           |
-|list_repo_commits|Commit|List all commits in a repository|
+|      list_repo_commits       |    Commit    |           List all commits in a repository            |
-|get_file_content|File|Get the content and metadata of a file|
+|       get_file_content       |     File     |        Get the content and metadata of a file         |
-|create_file|File|Create a new file|
+|         create_file          |     File     |                   Create a new file                   |
-|update_file|File|Update an existing file|
+|         update_file          |     File     |                Update an existing file                |
-|delete_file|File|Delete a file|
+|         delete_file          |     File     |                     Delete a file                     |
-|get_issue_by_index|Issue|Get an issue by its index|
+|      get_issue_by_index      |    Issue     |               Get an issue by its index               |
-|list_repo_issues|Issue|List all issues in a repository|
+|       list_repo_issues       |    Issue     |            List all issues in a repository            |
-|create_issue|Issue|Create a new issue|
+|         create_issue         |    Issue     |                  Create a new issue                   |
-|create_issue_comment|Issue|Create a comment on an issue|
+|     create_issue_comment     |    Issue     |             Create a comment on an issue              |
-|get_pull_request_by_index|Pull Request|Get a pull request by its index|
+|  get_pull_request_by_index   | Pull Request |            Get a pull request by its index            |
-|list_repo_pull_requests|Pull Request|List all pull requests in a repository|
+|   list_repo_pull_requests    | Pull Request |        List all pull requests in a repository         |
-|create_pull_request|Pull Request|Create a new pull request|
+|     create_pull_request      | Pull Request |               Create a new pull request               |
-|search_users|User|Search for users|
+|         search_users         |     User     |                   Search for users                    |
-|search_org_teams|Organization|Search for teams in an organization|
+|       search_org_teams       | Organization |          Search for teams in an organization          |
-|search_repos|Repository|Search for repositories|
+|         search_repos         |  Repository  |                Search for repositories                |
-|get_gitea_mcp_server_version|Server|Get the version of the Gitea MCP Server|
+| get_gitea_mcp_server_version |    Server    |        Get the version of the Gitea MCP Server        |
 
-## 🐛Debugging
+## 🐛 Debugging
 
 To enable debug mode, add the `-d` flag when running the Gitea MCP Server with sse mode:
 
@@ -121,4 +176,13 @@ To enable debug mode, add the `-d` flag when running the Gitea MCP Server with s
 ./gitea-mcp -t sse [--port 8080] --token <your personal access token> -d
 ```
 
+## 🛠 Troubleshooting
+
+If you encounter any issues, here are some common troubleshooting steps:
+
+1. **Check your PATH**: Ensure that the `gitea-mcp` binary is in a directory included in your system's PATH.
+2. **Verify dependencies**: Make sure you have all the required dependencies installed, such as `make` and `Golang`.
+3. **Review configuration**: Double-check your MCP configuration file for any errors or missing information.
+4. **Consult logs**: Check the logs for any error messages or warnings that can provide more information about the issue.
+
 Enjoy exploring and managing your Gitea repositories via chat!

cmd/cmd.go

@@ -80,6 +80,8 @@ func init() {
 		flagPkg.Token = os.Getenv("GITEA_ACCESS_TOKEN")
 	}
 
+	flagPkg.Mode = transport
+
 	if debug {
 		flagPkg.Debug = debug
 	}

go.mod

@@ -3,9 +3,10 @@ module gitea.com/gitea/gitea-mcp
 go 1.24.0
 
 require (
-	code.gitea.io/sdk/gitea v0.20.0
+	code.gitea.io/sdk/gitea v0.21.0
-	github.com/mark3labs/mcp-go v0.17.0
+	github.com/mark3labs/mcp-go v0.18.0
 	go.uber.org/zap v1.27.0
+	gopkg.in/natefinch/lumberjack.v2 v2.2.1
 )
 
 require (
@@ -17,5 +18,5 @@ require (
 	github.com/yosida95/uritemplate/v3 v3.0.2 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/crypto v0.36.0 // indirect
-	golang.org/x/sys v0.31.0 // indirect
+	golang.org/x/sys v0.32.0 // indirect
 )

go.sum

@@ -1,5 +1,5 @@
-code.gitea.io/sdk/gitea v0.20.0 h1:Zm/QDwwZK1awoM4AxdjeAQbxolzx2rIP8dDfmKu+KoU=
+code.gitea.io/sdk/gitea v0.21.0 h1:69n6oz6kEVHRo1+APQQyizkhrZrLsTLXey9142pfkD4=
-code.gitea.io/sdk/gitea v0.20.0/go.mod h1:faouBHC/zyx5wLgjmRKR62ydyvMzwWf3QnU0bH7Cw6U=
+code.gitea.io/sdk/gitea v0.21.0/go.mod h1:tnBjVhuKJCn8ibdyyhvUyxrR1Ca2KHEoTWoukNhXQPA=
 github.com/42wim/httpsig v1.2.2 h1:ofAYoHUNs/MJOLqQ8hIxeyz2QxOz8qdSVvp3PX/oPgA=
 github.com/42wim/httpsig v1.2.2/go.mod h1:P/UYo7ytNBFwc+dg35IubuAUIs8zj5zzFIgUCEl55WY=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
@@ -12,14 +12,12 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/hashicorp/go-version v1.7.0 h1:5tqGy27NaOTB8yJKUZELlFAS/LTKJkrmONwQKeRZfjY=
 github.com/hashicorp/go-version v1.7.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
-github.com/mark3labs/mcp-go v0.15.0 h1:lViiC4dk6chJHZccezaTzZLMOQVUXJDGNQPtzExr5NQ=
+github.com/mark3labs/mcp-go v0.18.0 h1:YuhgIVjNlTG2ZOwmrkORWyPTp0dz1opPEqvsPtySXao=
-github.com/mark3labs/mcp-go v0.15.0/go.mod h1:xBB350hekQsJAK7gJAii8bcEoWemboLm2mRm5/+KBaU=
+github.com/mark3labs/mcp-go v0.18.0/go.mod h1:KmJndYv7GIgcPVwEKJjNcbhVQ+hJGJhrCCB/9xITzpE=
-github.com/mark3labs/mcp-go v0.17.0 h1:5Ps6T7qXr7De/2QTqs9h6BKeZ/qdeUeGrgM5lPzi930=
-github.com/mark3labs/mcp-go v0.17.0/go.mod h1:KmJndYv7GIgcPVwEKJjNcbhVQ+hJGJhrCCB/9xITzpE=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
-github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4=
 github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
@@ -38,13 +36,15 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
+golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
-golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.30.0 h1:PQ39fJZ+mfadBm0y5WlL4vlM7Sx1Hgf13sMIY2+QS9Y=
 golang.org/x/term v0.30.0/go.mod h1:NYYFdzHoI5wRh/h5tDMdMqCqPJZEuNqVR5xJLd/n67g=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc=
+gopkg.in/natefinch/lumberjack.v2 v2.2.1/go.mod h1:YD8tP3GAjkrDg1eZH7EGmyESg/lsYskCTPBJVb9jqSc=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/flag/flag.go

@@ -5,6 +5,7 @@ var (
 	Port    int
 	Token   string
 	Version string
+	Mode    string
 
 	Debug bool
 )

pkg/log/log.go

@@ -1,6 +1,7 @@
 package log
 
 import (
+	"fmt"
 	"os"
 	"sync"
 	"time"
@@ -8,6 +9,7 @@ import (
 	"gitea.com/gitea/gitea-mcp/pkg/flag"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
+	"gopkg.in/natefinch/lumberjack.v2"
 )
 
 var (
@@ -20,12 +22,27 @@ func Default() *zap.Logger {
 		if defaultLogger == nil {
 			ec := zap.NewProductionEncoderConfig()
 			ec.EncodeTime = zapcore.TimeEncoderOfLayout(time.DateTime)
-			ec.EncodeLevel = zapcore.CapitalColorLevelEncoder
+			ec.EncodeLevel = zapcore.CapitalLevelEncoder
 
 			var ws zapcore.WriteSyncer
 			var wss []zapcore.WriteSyncer
 
+			home, _ := os.UserHomeDir()
+			if home == "" {
+				home = os.TempDir()
+			}
+
+			wss = append(wss, zapcore.AddSync(&lumberjack.Logger{
+				Filename:   fmt.Sprintf("%s/.gitea-mcp/gitea-mcp.log", home),
+				MaxSize:    100,
+				MaxBackups: 10,
+				MaxAge:     30,
+			}))
+
+			if flag.Mode == "sse" {
 				wss = append(wss, zapcore.AddSync(os.Stdout))
+			}
+
 			ws = zapcore.NewMultiWriteSyncer(wss...)
 
 			enc := zapcore.NewConsoleEncoder(ec)
@@ -37,7 +54,7 @@ func Default() *zap.Logger {
 			}
 			core := zapcore.NewCore(enc, ws, level)
 			options := []zap.Option{
-				zap.AddStacktrace(zapcore.ErrorLevel),
+				zap.AddStacktrace(zapcore.DPanicLevel),
 				zap.AddCaller(),
 				zap.AddCallerSkip(1),
 			}