Merge pull request 'Update README' (#4) from yp05327/gitea-mcp:update-readme into main

Reviewed-on: https://gitea.com/gitea/gitea-mcp/pulls/4
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
This commit is contained in:
Lunny Xiao
2025-03-25 04:28:34 +00:00

View File

@@ -4,7 +4,9 @@
## 🚧Installation ## 🚧Installation
There is currently no official release. You will need to build the Gitea MCP Server from source. ### 📥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
@@ -25,7 +27,7 @@ Then run:
make build 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: After building, copy the binary gitea-mcp to a directory included in your system's PATH. For example:
@@ -39,6 +41,7 @@ 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: To configure the MCP server for Gitea, add the following to your MCP configuration file:
- **stdio mode** - **stdio mode**
```json ```json
{ {
"mcpServers": { "mcpServers": {
@@ -59,6 +62,7 @@ To configure the MCP server for Gitea, add the following to your MCP configurati
``` ```
- **sse mode** - **sse mode**
```json ```json
{ {
"mcpServers": { "mcpServers": {
@@ -109,10 +113,10 @@ The Gitea MCP Server supports the following tools:
|search_repos|Repository|Search for repositories| |search_repos|Repository|Search for repositories|
|get_gitea_mcp_server_version|Server|Get the version of the Gitea MCP Server| |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: To enable debug mode, add the `-d` flag when running the Gitea MCP Server with sse mode:
```sh ```sh
./gitea-mcp -t sse --token <your personal access token> -d ./gitea-mcp -t sse --token <your personal access token> -d
``` ```