ai/gitea-mcp
1
0
Fork 0
mirror of https://gitea.com/gitea/gitea-mcp.git synced 2025-11-02 03:11:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: refine and unify Chinese README documentation and localization

Browse Source 
- Improve clarity and conciseness of installation and configuration instructions in both Simplified and Traditional Chinese README files
- Standardize terminology and phrasing for build, installation, and usage steps
- Refine and unify tool/function descriptions in the feature tables for greater consistency and accuracy
- Update troubleshooting steps for brevity and clarity
- Enhance overall readability and localization quality throughout both documents

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi Wu
2025-10-20 14:08:20 +08:00
parent f08720a625
commit 6930c8ee30
2 changed files with 152 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

156
README.zh-cn.md
View File

@@ -14,9 +14,9 @@
- [什么是 MCP？](#什么是-mcp)
- [🚧 安装](#-安装)
- [在 VS Code 中使用](#在-vs-code-中使用)
- [📥 下载官方 Gitea MCP 二进制版本](#-下载官方-gitea-mcp-二进制版本)
- [🔧 从源代码构建](#-从源代码构建)
- [📁 添加到 PATH](#-添加到-path)
- [📥 下载官方二进制版本](#-下载官方二进制版本)
- [🔧 从源码构建](#-从源码构建)
- [📁 加入 PATH](#-加入-path)
- [🚀 使用](#-使用)
- [✅ 可用工具](#-可用工具)
- [🐛 调试](#-调试)
@@ -24,23 +24,23 @@
## 什么是 Gitea？
Gitea 是一个由社区管理的轻量级代码托管解决方案，使用 Go 语言编写。它以 MIT 许可证发布。Gitea 提供 Git 托管，包括仓库查看器、问题追踪、拉取请求等功能。
Gitea 是一个由社区管理的轻量级代码托管解决方案，使用 Go 语言编写，采用 MIT 许可证。Gitea 提供 Git 托管，包括仓库浏览、问题追踪、拉取请求等功能。
## 什么是 MCP？
Model Context Protocol (MCP) 是一种协议，允许通过聊天界面整合各种工具和系统。它能够无缝执行命令和管理仓库、用户和其他资源。
Model Context Protocol (MCP) 是一种协议，允许通过聊天界面整合各种工具和系统。它能够无缝执行命令并管理仓库、用户及其他资源。
## 🚧 安装
### 在 VS Code 中使用
要快速安装，请使用本 README 顶部的单击安装按钮之一。
要快速安装，请使用本 README 顶部的安装按钮。
要手动安装，请将以下 JSON 块添加到 VS Code 的用户设置 (JSON) 文件中。您可以通过按 `Ctrl + Shift + P` 并输入 `Preferences: Open User Settings (JSON)` 来完成此操作。
如需手动安装，请将以下 JSON 块添加到 VS Code 的用户设置 (JSON) 文件。可通过按 `Ctrl + Shift + P` 并输入 `Preferences: Open User Settings (JSON)`。
或者，您可以将其添加到工作区中的 `.vscode/mcp.json` 文件中。这将允许您与他人共享配置。
也可添加到工作区的 `.vscode/mcp.json` 文件，方便与他人共享配置。
> 请注意，`.vscode/mcp.json` 文件中不需要 `mcp` 键。
> `.vscode/mcp.json` 文件不需要 `mcp` 键。
```json
{
@@ -73,22 +73,22 @@ Model Context Protocol (MCP) 是一种协议，允许通过聊天界面整合各
}
```
### 📥 下载官方 Gitea MCP 二进制版本
### 📥 下载官方二进制版本
您可以从[官方 Gitea MCP 二进制版本](https://gitea.com/gitea/gitea-mcp/releases)下载官方版本。
可在 [官方 Gitea MCP 二进制版本](https://gitea.com/gitea/gitea-mcp/releases) 下载。
### 🔧 从源代码构建
### 🔧 从源码构建
您可以使用 Git 克隆仓库来下载源代码：
可用 Git 下载源码：
```bash
git clone https://gitea.com/gitea/gitea-mcp.git
```
在构建之前，请确保您已安装以下内容：
构建前请先安装：
- make
- Golang (建议使用 Go 1.24 或更高版本)
- Golang（建议 Go 1.24 及以上）
然后运行：
@@ -96,9 +96,9 @@ git clone https://gitea.com/gitea/gitea-mcp.git
make install
```
### 📁 添加到 PATH
### 📁 加入 PATH
构建后，将二进制文件 gitea-mcp 复制到系统 PATH 中包含的目录。例如：
安装后，将 gitea-mcp 可执行文件复制到系统 PATH 目录，例如：
```bash
cp gitea-mcp /usr/local/bin/
@@ -106,8 +106,8 @@ cp gitea-mcp /usr/local/bin/
## 🚀 使用
此示例适用于 Cursor，您也可以在 VSCode 中使用插件。
要配置 Gitea 的 MCP 服务器，请将以下内容添加到您的 MCP 配置文件中：
此示例适用于 Cursor，也可在 VSCode 使用插件。
要配置 Gitea MCP 服务器，请将以下内容添加到 MCP 配置文件：
- **stdio 模式**
@@ -151,10 +151,10 @@ cp gitea-mcp /usr/local/bin/
**默认日志路径**: `$HOME/.gitea-mcp/gitea-mcp.log`
> [!注意]
> 您可以通过命令行参数或环境变量提供您的 Gitea 主机和访问令牌。
> 命令行参数具有最高优先级
> 可通过命令行参数或环境变量提供 Gitea 主机和访问令牌。
> 命令行参数优先。
一切设置完成后，请尝试在您的 MCP 兼容聊天框中输入以下内容：
一切设置完成后，可在 MCP 聊天框输入：
```text
列出我所有的仓库
@@ -164,59 +164,59 @@ cp gitea-mcp /usr/local/bin/
Gitea MCP 服务器支持以下工具：
| 工具 | 范围 | 描述 |
| :--------------------------: | :------: | :--------------------------: |
| get_my_user_info | 用户 | 获取已认证用户的信息 |
| get_user_orgs | 用户 | 获取已认证用户关联的组织 |
| create_repo | 仓库 | 创建一个新仓库 |
| fork_repo | 仓库 | 复刻一个仓库 |
| list_my_repos | 仓库 | 列出已认证用户拥有的所有仓库 |
| create_branch | 分支 | 创建一个新分支 |
| delete_branch | 分支 | 删除一个分支 |
| list_branches | 分支 | 列出仓库中的所有分支 |
| create_release | 版本发布 | 创建一个新版本发布 |
| delete_release | 版本发布 | 删除一个版本发布 |
| get_release | 版本发布 | 获取一个版本发布 |
| get_latest_release | 版本发布 | 获取最新的版本发布 |
| list_releases | 版本发布 | 列出所有版本发布 |
| create_tag | 标签 | 创建一个新标签 |
| delete_tag | 标签 | 删除一个标签 |
| get_tag | 标签 | 获取一个标签 |
| list_tags | 标签 | 列出所有标签 |
| list_repo_commits | 提交 | 列出仓库中的所有提交 |
| get_file_content | 文件 | 获取文件的内容和元数据 |
| get_dir_content | 文件 | 获取目录的内容列表 |
| create_file | 文件 | 创建一个新文件 |
| update_file | 文件 | 更新现有文件 |
| delete_file | 文件 | 删除一个文件 |
| get_issue_by_index | 问题 | 根据索引获取问题 |
| list_repo_issues | 问题 | 列出仓库中的所有问题 |
| create_issue | 问题 | 创建一个新问题 |
| create_issue_comment | 问题 | 在问题上创建评论 |
| edit_issue | 问题 | 编辑一个问题 |
| edit_issue_comment | 问题 | 在问题上编辑评论 |
| get_issue_comments_by_index | 问题 | 根据索引获取问题的评论 |
| get_pull_request_by_index | 拉取请求 | 根据索引获取拉取请求 |
| list_repo_pull_requests | 拉取请求 | 列出仓库中的所有拉取请求 |
| create_pull_request | 拉取请求 | 创建一个新拉取请求 |
| search_users | 用户 | 搜索用户 |
| search_org_teams | 组织 | 搜索组织中的团队 |
| list_org_labels | 组织 | 列出组织层级定义的标签 |
| create_org_label | 组织 | 在组织中创建一个标签 |
| edit_org_label | 组织 | 编辑组织中的一个标签 |
| delete_org_label | 组织 | 删除组织中的一个标签 |
| search_repos | 仓库 | 搜索仓库 |
| get_gitea_mcp_server_version | 服务器 | 获取 Gitea MCP 服务器的版本 |
| list_wiki_pages | Wiki | 列出仓库中的所有 Wiki 页面 |
| get_wiki_page | Wiki | 获取 Wiki 页面内容和元数据 |
| get_wiki_revisions | Wiki | 获取 Wiki 页面的修订历史 |
| create_wiki_page | Wiki | 创建一个新的 Wiki 页面 |
| update_wiki_page | Wiki | 更新现有的 Wiki 页面 |
| delete_wiki_page | Wiki | 删除一个 Wiki 页面 |
| 工具 | 范围 | 描述 |
| :--------------------------: | :------: | :------------------------: |
| get_my_user_info | 用户 | 获取已认证用户信息 |
| get_user_orgs | 用户 | 获取已认证用户关联组织 |
| create_repo | 仓库 | 创建新仓库 |
| fork_repo | 仓库 | 复刻仓库 |
| list_my_repos | 仓库 | 列出用户所有仓库 |
| create_branch | 分支 | 创建新分支 |
| delete_branch | 分支 | 删除分支 |
| list_branches | 分支 | 列出所有分支 |
| create_release | 版本发布 | 创建新版本发布 |
| delete_release | 版本发布 | 删除版本发布 |
| get_release | 版本发布 | 获取版本发布 |
| get_latest_release | 版本发布 | 获取最新版本发布 |
| list_releases | 版本发布 | 列出所有版本发布 |
| create_tag | 标签 | 创建新标签 |
| delete_tag | 标签 | 删除标签 |
| get_tag | 标签 | 获取标签 |
| list_tags | 标签 | 列出所有标签 |
| list_repo_commits | 提交 | 列出所有提交 |
| get_file_content | 文件 | 获取文件内容和元数据 |
| get_dir_content | 文件 | 获取目录内容列表 |
| create_file | 文件 | 创建新文件 |
| update_file | 文件 | 更新现有文件 |
| delete_file | 文件 | 删除文件 |
| get_issue_by_index | 问题 | 按索引获取问题 |
| list_repo_issues | 问题 | 列出所有问题 |
| create_issue | 问题 | 创建新问题 |
| create_issue_comment | 问题 | 在问题上创建评论 |
| edit_issue | 问题 | 编辑问题 |
| edit_issue_comment | 问题 | 编辑问题评论 |
| get_issue_comments_by_index | 问题 | 按索引获取问题评论 |
| get_pull_request_by_index | 拉取请求 | 按索引获取拉取请求 |
| list_repo_pull_requests | 拉取请求 | 列出所有拉取请求 |
| create_pull_request | 拉取请求 | 创建新拉取请求 |
| search_users | 用户 | 搜索用户 |
| search_org_teams | 组织 | 搜索组织团队 |
| list_org_labels | 组织 | 列出组织标签 |
| create_org_label | 组织 | 创建组织标签 |
| edit_org_label | 组织 | 编辑组织标签 |
| delete_org_label | 组织 | 删除组织标签 |
| search_repos | 仓库 | 搜索仓库 |
| get_gitea_mcp_server_version | 服务器 | 获取 Gitea MCP 服务器版本 |
| list_wiki_pages | Wiki | 列出所有 Wiki 页面 |
| get_wiki_page | Wiki | 获取 Wiki 页面内容和元数据 |
| get_wiki_revisions | Wiki | 获取 Wiki 修订历史 |
| create_wiki_page | Wiki | 创建新 Wiki 页面 |
| update_wiki_page | Wiki | 更新现有 Wiki 页面 |
| delete_wiki_page | Wiki | 删除 Wiki 页面 |
## 🐛 调试
要启用调试模式，请在使用 http 模式运行 Gitea MCP 服务器时添加 `-d` 标志：
启用调试模式时，请在 http 模式运行 Gitea MCP 服务器时加上 `-d` 标志：
```sh
./gitea-mcp -t http [--port 8080] --token <your personal access token> -d
@@ -224,11 +224,11 @@ Gitea MCP 服务器支持以下工具：
## 🛠 疑难排解
如果您遇到任何问题，以下是一些常见的疑难排解步骤：
如遇问题，可参考以下步骤：
1. **检查您的 PATH**: 确保 `gitea-mcp` 二进制文件位于系统 PATH 中包含的目录中。
2. **验证依赖项**: 确保您已安装所有所需的依赖项，例如 `make` 和 `Golang`。
3. **检查配置**: 仔细检查您的 MCP 配置文件是否有任何错误或遗漏的信息。
4. **查看日志**: 检查日志中是否有任何错误消息或警告，可以提供有关问题的更多信息。
1. **检查 PATH**：确保 `gitea-mcp` 可执行文件已在系统 PATH 目录中。
2. **验证依赖**：确认已安装 `make` 和 `Golang` 等必要依赖。
3. **检查配置**：仔细检查 MCP 配置文件是否有错误或遗漏。
4. **查看日志**：检查日志消息或警告以获取更多信息。
享受通过聊天探索和管理您的 Gitea 仓库的乐趣！
享受通过聊天探索和管理您的 Gitea 仓库！