mirror of
https://gitea.com/gitea/gitea-mcp.git
synced 2025-08-23 22:33:05 +00:00
docs: improve documentation with new sections and better readability (#12)
- Add a "What is Gitea?" section explaining Gitea - Add a "What is MCP?" section describing Model Context Protocol - Reformat the MCP server configuration instructions for better readability - Correct the markdown table for tool support - Add a Troubleshooting section with common steps to resolve issues Signed-off-by: appleboy <appleboy.tw@gmail.com> Reviewed-on: https://gitea.com/gitea/gitea-mcp/pulls/12 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: appleboy <appleboy.tw@gmail.com> Co-committed-by: appleboy <appleboy.tw@gmail.com>
This commit is contained in:
25
README.md
25
README.md
@@ -2,6 +2,14 @@
|
|||||||
|
|
||||||
**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.
|
**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.
|
||||||
|
|
||||||
|
## What is Gitea?
|
||||||
|
|
||||||
|
Gitea is a community-managed lightweight code hosting solution written in Go. It is published under the MIT license. Gitea provides Git hosting including a repository viewer, issue tracking, pull requests, and more.
|
||||||
|
|
||||||
|
## What is MCP?
|
||||||
|
|
||||||
|
Model Context Protocol (MCP) is a protocol that allows for the integration of various tools and systems through a chat interface. It enables seamless command execution and management of repositories, users, and other resources.
|
||||||
|
|
||||||
## 🚧 Installation
|
## 🚧 Installation
|
||||||
|
|
||||||
### 📥 Download the official binary release
|
### 📥 Download the official binary release
|
||||||
@@ -48,8 +56,10 @@ To configure the MCP server for Gitea, add the following to your MCP configurati
|
|||||||
"gitea": {
|
"gitea": {
|
||||||
"command": "gitea-mcp",
|
"command": "gitea-mcp",
|
||||||
"args": [
|
"args": [
|
||||||
"-t", "stdio",
|
"-t",
|
||||||
"--host", "https://gitea.com"
|
"stdio",
|
||||||
|
"--host",
|
||||||
|
"https://gitea.com"
|
||||||
// "--token", "<your personal access token>"
|
// "--token", "<your personal access token>"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
@@ -88,7 +98,7 @@ list all my repositories
|
|||||||
The Gitea MCP Server supports the following tools:
|
The Gitea MCP Server supports the following tools:
|
||||||
|
|
||||||
| Tool | Scope | Description |
|
| Tool | Scope | Description |
|
||||||
|:------:|:-------:|:------------:|
|
| :--------------------------: | :----------: | :---------------------------------------------------: |
|
||||||
| get_my_user_info | User | Get the information of the authenticated user |
|
| get_my_user_info | User | Get the information of the authenticated user |
|
||||||
| create_repo | Repository | Create a new repository |
|
| create_repo | Repository | Create a new repository |
|
||||||
| fork_repo | Repository | Fork a repository |
|
| fork_repo | Repository | Fork a repository |
|
||||||
@@ -121,4 +131,13 @@ To enable debug mode, add the `-d` flag when running the Gitea MCP Server with s
|
|||||||
./gitea-mcp -t sse [--port 8080] --token <your personal access token> -d
|
./gitea-mcp -t sse [--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.
|
||||||
|
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.
|
||||||
|
|
||||||
Enjoy exploring and managing your Gitea repositories via chat!
|
Enjoy exploring and managing your Gitea repositories via chat!
|
||||||
|
Reference in New Issue
Block a user