Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
424732cc91 |
30
README.md
30
README.md
@@ -1,14 +1,10 @@
|
||||
# Gitea MCP Server
|
||||
# Gitea MCP Extended Server
|
||||
|
||||
[繁體中文](README.zh-tw.md) | [简体中文](README.zh-cn.md)
|
||||
|
||||
**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.
|
||||
|
||||
[](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}}) [](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 MCP Extended Server** is a fork of [gitea/gitea-mcp](https://gitea.com/gitea/gitea-mcp) with significantly expanded tool coverage (299+ tools). It connects Gitea with Model Context Protocol (MCP) systems, allowing seamless command execution and repository management through an MCP-compatible chat interface.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Gitea MCP Server](#gitea-mcp-server)
|
||||
- [Gitea MCP Extended Server](#gitea-mcp-extended-server)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [What is Gitea?](#what-is-gitea)
|
||||
- [What is MCP?](#what-is-mcp)
|
||||
@@ -41,7 +37,7 @@ This method uses `go run` and requires [Go](https://go.dev) to be installed.
|
||||
claude mcp add --transport stdio --scope user gitea \
|
||||
--env GITEA_ACCESS_TOKEN=token \
|
||||
--env GITEA_HOST=https://gitea.com \
|
||||
-- go run git.lethalbits.com/lethalbits/gitea-mcp@latest -t stdio
|
||||
-- go run git.lethalbits.com/lethalbits/gitea-mcp-extended@latest -t stdio
|
||||
```
|
||||
|
||||
### Usage with VS Code
|
||||
@@ -87,14 +83,14 @@ Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace
|
||||
|
||||
### 📥 Download the official binary release
|
||||
|
||||
You can download the official release from [official Gitea MCP binary releases](https://git.lethalbits.com/lethalbits/gitea-mcp/releases).
|
||||
You can download the official release from [official Gitea MCP Extended binary releases](https://git.lethalbits.com/lethalbits/gitea-mcp-extended/releases).
|
||||
|
||||
### 🔧 Build from Source
|
||||
|
||||
You can download the source code by cloning the repository using Git:
|
||||
|
||||
```bash
|
||||
git clone https://git.lethalbits.com/lethalbits/gitea-mcp.git
|
||||
git clone https://git.lethalbits.com/lethalbits/gitea-mcp-extended.git
|
||||
```
|
||||
|
||||
Before building, make sure you have the following installed:
|
||||
@@ -110,10 +106,10 @@ make install
|
||||
|
||||
### 📁 Add to PATH
|
||||
|
||||
After installing, copy the binary gitea-mcp to a directory included in your system's PATH. For example:
|
||||
After installing, copy the binary gitea-mcp-extended to a directory included in your system's PATH. For example:
|
||||
|
||||
```bash
|
||||
cp gitea-mcp /usr/local/bin/
|
||||
cp gitea-mcp-extended /usr/local/bin/
|
||||
```
|
||||
|
||||
## 🚀 Usage
|
||||
@@ -127,7 +123,7 @@ To configure the MCP server for Gitea, add the following to your MCP configurati
|
||||
{
|
||||
"mcpServers": {
|
||||
"gitea": {
|
||||
"command": "gitea-mcp",
|
||||
"command": "gitea-mcp-extended",
|
||||
"args": [
|
||||
"-t",
|
||||
"stdio",
|
||||
@@ -160,7 +156,7 @@ To configure the MCP server for Gitea, add the following to your MCP configurati
|
||||
}
|
||||
```
|
||||
|
||||
**Default log path**: `$HOME/.gitea-mcp/gitea-mcp.log`
|
||||
**Default log path**: `$HOME/.gitea-mcp/gitea-mcp.log` (log directory unchanged from upstream for backward compatibility)
|
||||
|
||||
> [!NOTE]
|
||||
> You can provide your Gitea host and access token either as command-line arguments or environment variables.
|
||||
@@ -174,7 +170,7 @@ list all my repositories
|
||||
|
||||
## ✅ Available Tools
|
||||
|
||||
The Gitea MCP Server supports the following tools:
|
||||
The Gitea MCP Extended Server supports the following tools:
|
||||
|
||||
| Tool | Scope | Description |
|
||||
| :-------------------------------: | :----------: | :------------------------------------------------------: |
|
||||
@@ -269,14 +265,14 @@ The Gitea MCP Server supports the following tools:
|
||||
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 <your personal access token> -d
|
||||
./gitea-mcp-extended -t http [--port 8080] --token <your personal access 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.
|
||||
1. **Check your PATH**: Ensure that the `gitea-mcp-extended` 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.
|
||||
|
||||
Reference in New Issue
Block a user