Improve the README

2025-03-17 21:13:45 -07:00
parent a5504ca7e0
commit ea394e4693
1 changed files with 44 additions and 7 deletions
--- a/README.md
+++ b/README.md
@@ -1,23 +1,60 @@
 # Gitea MCP Server 
 
-## Usage 
+**Gitea MCP Server** is an integration plugin designed to connect Gitea with Multi-Command Protocol (MCP) systems. This allows for seamless command execution and repository management through an MCP-compatible chat interface. 
+ 
+## 🚧 Installation 
+ 
+There is currently no official release. You will need to build the Gitea MCP Server from source. 
+ 
+### 🔧 Build from Source 
+ 
+Before building, make sure you have the following installed: 
+- make 
+- Golang (Go 1.24 or later recommended) 
+ 
+Clone the repository and run: 
+ 
+```bash 
+make build 
+``` 
+ 
+### 🛠️ Add to PATH 
+ 
+After building, copy the binary gitea-mcp to a directory included in your system’s PATH. For example: 
+ 
+```bash 
+cp gitea-mcp /usr/local/bin/ 
+``` 
+ 
+## 🚀 Usage 
+ 
+To configure the MCP server for Gitea, add the following to your MCP configuration file: 
 
-**MCP Server Config** 
 ```json 
 { 
 "mcpServers": { 
 "gitea": { 
 "command": "gitea-mcp", 
 "args": [ 
- "-t": "stdio", 
- "--host": "https://gitea.com"//, 
- // "--token": "<your personal access token>" 
+ "-t", "stdio", 
+ "--host", "https://gitea.com" 
+  // "--token", "<your personal access token>" 
 ], 
 "env": { 
- //  "GITEA_HOST": "https://gitea.com", 
-  "GITEA_ACCESS_TOKEN": "<your personal access token>" 
+  // "GITEA_HOST": "https://gitea.com", 
+ "GITEA_ACCESS_TOKEN": "<your personal access token>" 
 } 
 } 
 } 
 } 
 ``` 
+> [!NOTE] 
+> You can provide your Gitea host and access token either as command-line arguments or environment variables. 
+ 
+Once everything is set up, try typing the following in your MCP-compatible chatbox: 
+ 
+``` 
+list all my repositories 
+``` 
+ 
+Enjoy exploring and managing your Gitea repositories via chat!