Files
gitea-mcp/README.md
2025-03-17 21:13:45 -07:00

60 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Gitea MCP Server
**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 systems 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:
```json
{
"mcpServers": {
"gitea": {
"command": "gitea-mcp",
"args": [
"-t", "stdio",
"--host", "https://gitea.com"
// "--token", "<your personal access token>"
],
"env": {
// "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!