From eaac0ed20faf76ae3363e63cb54fa01bf768457d Mon Sep 17 00:00:00 2001 From: ben Date: Mon, 2 Feb 2026 02:23:00 +0000 Subject: [PATCH] Add README for concept validation project --- README.md | 278 ++++-------------------------------------------------- 1 file changed, 17 insertions(+), 261 deletions(-) diff --git a/README.md b/README.md index d0ec24d..b9944b9 100644 --- a/README.md +++ b/README.md @@ -1,270 +1,26 @@ -# Gitea MCP Server +# Gitea Actions 概念验证项目 -[繁體中文](README.zh-tw.md) | [简体中文](README.zh-cn.md) +本项目旨在通过控制阿里巴巴 DSW WebIDE 作为自托管 runner，验证 Gitea Actions 功能。 -**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. +## 项目目的 -[![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) +- 概念验证：验证 Gitea Actions 在私有部署环境中的功能 +- 资源利用：利用阿里云 DSW 服务的计算资源作为自托管 runner +- 网络优化：在境内环境中进行 CI/CD 操作，避免国际网络延迟 -## Table of Contents +## 架构说明 -- [Gitea MCP Server](#gitea-mcp-server) - - [Table of Contents](#table-of-contents) - - [What is Gitea?](#what-is-gitea) - - [What is MCP?](#what-is-mcp) - - [🚧 Installation](#-installation) - - [Usage with VS Code](#usage-with-vs-code) - - [📥 Download the official binary release](#-download-the-official-binary-release) - - [🔧 Build from Source](#-build-from-source) - - [📁 Add to PATH](#-add-to-path) - - [🚀 Usage](#-usage) - - [✅ Available Tools](#-available-tools) - - [🐛 Debugging](#-debugging) - - [🛠 Troubleshooting](#-troubleshooting) +- Gitea 实例：私有部署 (`https://gitea.tailnet-68f9.ts.net`) +- 自托管 runner：运行在阿里云 DSW 服务上 +- 工作流：通过 `.gitea/workflows/` 目录下的 YAML 文件定义 -## 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. +- Runner 已注册并连接到 Gitea 实例 +- 测试工作流用于验证基本功能 +- 重点：所有操作均在中国境内网络环境下执行 -## 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": { - "gitea-mcp": { - "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 [official Gitea MCP binary releases](https://gitea.com/gitea/gitea-mcp/releases). - -### 🔧 Build from Source - -You can download the source code by cloning the repository using Git: - -```bash -git clone https://gitea.com/gitea/gitea-mcp.git -``` - -Before building, make sure you have the following installed: - -- make -- Golang (Go 1.24 or later recommended) - -Then run: - -```bash -make install -``` - -### 📁 Add to PATH - -After installing, copy the binary gitea-mcp to a directory included in your system's PATH. For example: - -```bash -cp gitea-mcp /usr/local/bin/ -``` - -## 🚀 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: - -- **stdio mode** - -```json -{ - "mcpServers": { - "gitea": { - "command": "gitea-mcp", - "args": [ - "-t", - "stdio", - "--host", - "https://gitea.com" - // "--token", "" - ], - "env": { - // "GITEA_HOST": "https://gitea.com", - // "GITEA_INSECURE": "true", - "GITEA_ACCESS_TOKEN": "" - } - } - } -} -``` - -- **http mode** - -```json -{ - "mcpServers": { - "gitea": { - "url": "http://localhost:8080/mcp", - "headers": { - "Authorization": "Bearer " - } - } - } -} -``` - -**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 - -Once everything is set up, try typing the following in your MCP-compatible chatbox: - -```text -list all my repositories -``` - -## ✅ 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_user_orgs | User | Get organizations associated with the authenticated user | -| create_repo | Repository | Create a new repository | -| fork_repo | Repository | Fork a repository | -| list_my_repos | Repository | List all repositories owned by the authenticated user | -| create_branch | Branch | Create a new branch | -| delete_branch | Branch | Delete a branch | -| list_branches | Branch | List all branches in a repository | -| create_release | Release | Create a new release in a repository | -| delete_release | Release | Delete a release from a repository | -| get_release | Release | Get a release | -| get_latest_release | Release | Get the latest release in a repository | -| list_releases | Release | List all releases in a repository | -| create_tag | Tag | Create a new tag | -| delete_tag | Tag | Delete a tag | -| get_tag | Tag | Get a tag | -| list_tags | Tag | List all tags 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_dir_content | File | Get a list of entries in a directory | -| create_file | File | Create a new file | -| update_file | File | Update an existing file | -| delete_file | File | Delete a file | -| get_issue_by_index | Issue | Get an issue by its index | -| list_repo_issues | Issue | List all issues in a repository | -| create_issue | Issue | Create a new issue | -| create_issue_comment | Issue | Create a comment on an issue | -| edit_issue | Issue | Edit a issue | -| edit_issue_comment | Issue | Edit a comment on an issue | -| get_issue_comments_by_index | Issue | Get comments of an issue 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 | -| create_pull_request | Pull Request | Create a new pull request | -| create_pull_request_reviewer | Pull Request | Add reviewers to a pull request | -| delete_pull_request_reviewer | Pull Request | Remove reviewers from a pull request | -| list_pull_request_reviews | Pull Request | List all reviews for a pull request | -| get_pull_request_review | Pull Request | Get a specific review by ID | -| list_pull_request_review_comments | Pull Request | List inline comments for a review | -| create_pull_request_review | Pull Request | Create a review with optional inline comments | -| submit_pull_request_review | Pull Request | Submit a pending review | -| delete_pull_request_review | Pull Request | Delete a review | -| dismiss_pull_request_review | Pull Request | Dismiss a review with optional message | -| search_users | User | Search for users | -| search_org_teams | Organization | Search for teams in an organization | -| list_org_labels | Organization | List labels defined at organization level | -| create_org_label | Organization | Create a label in an organization | -| edit_org_label | Organization | Edit a label in an organization | -| delete_org_label | Organization | Delete a label in an organization | -| search_repos | Repository | Search for repositories | -| list_repo_action_secrets | Actions | List repository Actions secrets (metadata only) | -| upsert_repo_action_secret | Actions | Create/update (upsert) a repository Actions secret | -| delete_repo_action_secret | Actions | Delete a repository Actions secret | -| list_org_action_secrets | Actions | List organization Actions secrets (metadata only) | -| upsert_org_action_secret | Actions | Create/update (upsert) an organization Actions secret | -| delete_org_action_secret | Actions | Delete an organization Actions secret | -| list_repo_action_variables | Actions | List repository Actions variables | -| get_repo_action_variable | Actions | Get a repository Actions variable | -| create_repo_action_variable | Actions | Create a repository Actions variable | -| update_repo_action_variable | Actions | Update a repository Actions variable | -| delete_repo_action_variable | Actions | Delete a repository Actions variable | -| list_org_action_variables | Actions | List organization Actions variables | -| get_org_action_variable | Actions | Get an organization Actions variable | -| create_org_action_variable | Actions | Create an organization Actions variable | -| update_org_action_variable | Actions | Update an organization Actions variable | -| delete_org_action_variable | Actions | Delete an organization Actions variable | -| list_repo_action_workflows | Actions | List repository Actions workflows | -| get_repo_action_workflow | Actions | Get a repository Actions workflow | -| dispatch_repo_action_workflow | Actions | Trigger (dispatch) a repository Actions workflow | -| list_repo_action_runs | Actions | List repository Actions runs | -| get_repo_action_run | Actions | Get a repository Actions run | -| cancel_repo_action_run | Actions | Cancel a repository Actions run | -| rerun_repo_action_run | Actions | Rerun a repository Actions run | -| list_repo_action_jobs | Actions | List repository Actions jobs | -| list_repo_action_run_jobs | Actions | List Actions jobs for a run | -| get_repo_action_job_log_preview | Actions | Get a job log preview (tail/limited) | -| download_repo_action_job_log | Actions | Download a job log to a file | -| get_gitea_mcp_server_version | Server | Get the version of the Gitea MCP Server | -| list_wiki_pages | Wiki | List all wiki pages in a repository | -| get_wiki_page | Wiki | Get a wiki page content and metadata | -| get_wiki_revisions | Wiki | Get revisions history of a wiki page | -| create_wiki_page | Wiki | Create a new wiki page | -| update_wiki_page | Wiki | Update an existing wiki page | -| delete_wiki_page | Wiki | Delete a wiki page | - -## 🐛 Debugging - -To enable debug mode, add the `-d` flag when running the Gitea MCP Server with http mode: - -```sh -./gitea-mcp -t http [--port 8080] --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! +- `local-test.yml`：测试从仓库下载 README 文件 +- 使用纯 shell 命令，避免访问 GitHub \ No newline at end of file