diff --git a/README.md b/README.md index 9eb1a21..9a1c149 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,21 @@ **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. -## 🚧Installation +## What is Gitea? -### 📥Download the official binary release +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 + +### 📥 Download the official binary release You can download the official release from [here](https://gitea.com/gitea/gitea-mcp/releases). -### 🔧Build from Source +### 🔧 Build from Source You can download the source code by cloning the repository using Git: @@ -27,7 +35,7 @@ Then run: make build ``` -### 📁Add to PATH +### 📁 Add to PATH After building, copy the binary gitea-mcp to a directory included in your system's PATH. For example: @@ -35,7 +43,7 @@ After building, copy the binary gitea-mcp to a directory included in your system cp gitea-mcp /usr/local/bin/ ``` -## 🚀Usage +## 🚀 Usage This example is for Cursor, you can also use plugins in VSCode. To configure the MCP server for Gitea, add the following to your MCP configuration file: @@ -48,8 +56,10 @@ To configure the MCP server for Gitea, add the following to your MCP configurati "gitea": { "command": "gitea-mcp", "args": [ - "-t", "stdio", - "--host", "https://gitea.com" + "-t", + "stdio", + "--host", + "https://gitea.com" // "--token", "" ], "env": { @@ -83,37 +93,37 @@ Once everything is set up, try typing the following in your MCP-compatible chatb list all my repositories ``` -## ✅Available Tools +## ✅ Available Tools The Gitea MCP Server supports the following tools: -| Tool | Scope | Description | -|:------:|:-------:|:------------:| -|get_my_user_info|User|Get the information of the authenticated user| -|create_repo|Repository|Create a new repository| -|fork_repo|Repository|Fork a repository| -|list_my_repos|Repository|List all repositories owned by the authenticated user| -|create_branch|Branch|Create a new branch| -|delete_branch|Branch|Delete a branch| -|list_branches|Branch|List all branches in a repository| -|list_repo_commits|Commit|List all commits in a repository| -|get_file_content|File|Get the content and metadata of a file| -|create_file|File|Create a new file| -|update_file|File|Update an existing file| -|delete_file|File|Delete a file| -|get_issue_by_index|Issue|Get an issue by its index| -|list_repo_issues|Issue|List all issues in a repository| -|create_issue|Issue|Create a new issue| -|create_issue_comment|Issue|Create a comment on an issue| -|get_pull_request_by_index|Pull Request|Get a pull request by its index| -|list_repo_pull_requests|Pull Request|List all pull requests in a repository| -|create_pull_request|Pull Request|Create a new pull request| -|search_users|User|Search for users| -|search_org_teams|Organization|Search for teams in an organization| -|search_repos|Repository|Search for repositories| -|get_gitea_mcp_server_version|Server|Get the version of the Gitea MCP Server| +| Tool | Scope | Description | +| :--------------------------: | :----------: | :---------------------------------------------------: | +| get_my_user_info | User | Get the information of the authenticated user | +| create_repo | Repository | Create a new repository | +| fork_repo | Repository | Fork a repository | +| list_my_repos | Repository | List all repositories owned by the authenticated user | +| create_branch | Branch | Create a new branch | +| delete_branch | Branch | Delete a branch | +| list_branches | Branch | List all branches in a repository | +| list_repo_commits | Commit | List all commits in a repository | +| get_file_content | File | Get the content and metadata of a file | +| create_file | File | Create a new file | +| update_file | File | Update an existing file | +| delete_file | File | Delete a file | +| get_issue_by_index | Issue | Get an issue by its index | +| list_repo_issues | Issue | List all issues in a repository | +| create_issue | Issue | Create a new issue | +| create_issue_comment | Issue | Create a comment on an issue | +| get_pull_request_by_index | Pull Request | Get a pull request by its index | +| list_repo_pull_requests | Pull Request | List all pull requests in a repository | +| create_pull_request | Pull Request | Create a new pull request | +| search_users | User | Search for users | +| search_org_teams | Organization | Search for teams in an organization | +| search_repos | Repository | Search for repositories | +| get_gitea_mcp_server_version | Server | Get the version of the Gitea MCP Server | -## 🐛Debugging +## 🐛 Debugging To enable debug mode, add the `-d` flag when running the Gitea MCP Server with sse mode: @@ -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 -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!