Skip to content

Commit 085880c

Browse files
committed
docs: Add practical scenario and images to README
Added a detailed practical scenario with images to demonstrate how to obtain issues from the repository, implement them, and create a pull request. Updated command examples for different modes.
1 parent 0765059 commit 085880c

File tree

5 files changed

+36
-0
lines changed

5 files changed

+36
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@ Gitee MCP Server is a Model Context Protocol (MCP) server implementation for Git
99
- Command-line flags for easy configuration
1010
- Supports both personal, organization, and enterprise operations
1111

12+
<details>
13+
<summary><b>Practical scenario: Obtain Issue from the warehouse, implement and create a Pull Requestb>summary>
14+
15+
1. Get repository Issues
16+
![get_repo_issues](./docs/images/get_repo_issues.jpg)
17+
2. Implement coding & create Pull Request based on Issue details
18+
![implement_issue](./docs/images/implement_issue.jpg)
19+
3. Comment & Close Issue
20+
![comment_and_close_issue](./docs/images/comment_and_close_issue.jpg)
21+
details>
22+
1223
## Installation
1324

1425
### Prerequisites
@@ -47,10 +58,17 @@ mcp-gitee --version
4758
For example, taking Windsurf and Cursor as an example, Claude Desktop, Cline, Roocode are analogous.
4859

4960
**Cursor**:
61+
62+
stdio mode
5063
```bash
5164
mcp-gitee -token <Your Personal Access Token>
5265
```
5366

67+
sse mode
68+
```bash
69+
mcp-gitee -transport sse -token <Your Personal Access Token>
70+
```
71+
5472
**Windsurf**:
5573
```json
5674
{

README_CN.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@ Gitee MCP 服务器是一个用于 Gitee 的模型上下文协议(Model Contex
99
- 命令行标志,便于配置
1010
- 支持个人、组织和企业操作
1111

12+
<details>
13+
<summary><b>实战场景:从仓库获取 Issue,实现并创建 Pull Requestb>summary>
14+
15+
1. 获取当前仓库 Issues
16+
![get_repo_issues](./docs/images/get_repo_issues.jpg)
17+
2. 根据 Issue 详情实现编码 & 创建 Pull Request
18+
![implement_issue](./docs/images/implement_issue.jpg)
19+
3. 评论&关闭Issue
20+
![comment_and_close_issue](./docs/images/comment_and_close_issue.jpg)
21+
details>
22+
1223
## 安装
1324

1425
### 前提条件
@@ -48,10 +59,17 @@ mcp-gitee --version
4859
例如,以 Windsurf、Cursor 为例,Claude Desktop、Cline、RooCode 都是类似的。
4960

5061
**Cursor**:
62+
63+
stdio mode
5164
```bash
5265
mcp-gitee -token <Your Personal Access Token>
5366
```
5467

68+
sse mode
69+
```bash
70+
mcp-gitee -transport sse -token <Your Personal Access Token>
71+
```
72+
5573
**Windsurf**:
5674
```json
5775
{
966 KB
Loading

docs/images/get_repo_issues.jpg

801 KB
Loading

docs/images/implement_issue.jpg

889 KB
Loading

0 commit comments

Comments
 (0)