From 7cb3f00fcf490947584203a5c29cbbe260cd579d Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 13 Jun 2025 03:27:34 +0000 Subject: [PATCH] Update README.md --- README.en.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 172 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..8ad792b --- /dev/null +++ b/README.en.md @@ -0,0 +1,86 @@ +# Gitee MCP Server + +Gitee MCP (Model Control Protocol) Server provides a bridge between AI models and Gitee Enterprise Edition, enabling seamless integration and automation of various tasks within the Gitee ecosystem. This server exposes a set of tools that can be used by AI models to interact with Gitee's API for tasks such as issue management, pull requests, repository operations, and more. + +## Features + +- **Issue Management**: Create, update, comment, and list issues. +- **Pull Requests**: Create, update, merge, and comment on pull requests. +- **Repository Operations**: Create repositories, get file content, list releases, and more. +- **Enterprise Management**: Manage enterprises, groups, members, and programs. +- **Scrum Support**: Handle scrum sprints and versions. +- **Labels & Types**: Manage labels and issue types. + +## Installation + +### Prerequisites + +- Go 1.23 or later +- Docker (for containerized deployment) + +### From Source + +1. Clone the repository: + ```bash + git clone https://github.com/yourusername/gitee-mcp-server.git + cd gitee-mcp-server + ``` + +2. Build the binary: + ```bash + go build -o mcp-gitee-ent + ``` + +3. Run the server: + ```bash + ./mcp-gitee-ent + ``` + +### Using Docker + +1. Build the Docker image: + ```bash + docker build -t gitee-mcp-server . + ``` + +2. Run the Docker container: + ```bash + docker run -p 8000:8000 gitee-mcp-server + ``` + +## Usage + +The Gitee MCP Server listens on port 8000 by default. You can interact with it using the Model Control Protocol. + +### Environment Variables + +- `GITEE_ACCESS_TOKEN`: Your Gitee access token. +- `API_BASE`: Custom API base URL (optional). + +### Command Line Options + +- `--transport`: Transport protocol (default: "tcp"). +- `--addr`: Address to bind (default: ":8000"). + +### Example + +To start the server with custom transport and address: +```bash +./mcp-gitee-ent --transport=tcp --addr=:8080 +``` + +## Contributing + +We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to this project. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. + +## Contact + +For any questions or feedback, please reach out to us via GitHub issues or email. + +--- + +For more detailed information, including specific tool usage and examples, refer to the [README_CN.md](README_CN.md) file. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ad792b --- /dev/null +++ b/README.md @@ -0,0 +1,86 @@ +# Gitee MCP Server + +Gitee MCP (Model Control Protocol) Server provides a bridge between AI models and Gitee Enterprise Edition, enabling seamless integration and automation of various tasks within the Gitee ecosystem. This server exposes a set of tools that can be used by AI models to interact with Gitee's API for tasks such as issue management, pull requests, repository operations, and more. + +## Features + +- **Issue Management**: Create, update, comment, and list issues. +- **Pull Requests**: Create, update, merge, and comment on pull requests. +- **Repository Operations**: Create repositories, get file content, list releases, and more. +- **Enterprise Management**: Manage enterprises, groups, members, and programs. +- **Scrum Support**: Handle scrum sprints and versions. +- **Labels & Types**: Manage labels and issue types. + +## Installation + +### Prerequisites + +- Go 1.23 or later +- Docker (for containerized deployment) + +### From Source + +1. Clone the repository: + ```bash + git clone https://github.com/yourusername/gitee-mcp-server.git + cd gitee-mcp-server + ``` + +2. Build the binary: + ```bash + go build -o mcp-gitee-ent + ``` + +3. Run the server: + ```bash + ./mcp-gitee-ent + ``` + +### Using Docker + +1. Build the Docker image: + ```bash + docker build -t gitee-mcp-server . + ``` + +2. Run the Docker container: + ```bash + docker run -p 8000:8000 gitee-mcp-server + ``` + +## Usage + +The Gitee MCP Server listens on port 8000 by default. You can interact with it using the Model Control Protocol. + +### Environment Variables + +- `GITEE_ACCESS_TOKEN`: Your Gitee access token. +- `API_BASE`: Custom API base URL (optional). + +### Command Line Options + +- `--transport`: Transport protocol (default: "tcp"). +- `--addr`: Address to bind (default: ":8000"). + +### Example + +To start the server with custom transport and address: +```bash +./mcp-gitee-ent --transport=tcp --addr=:8080 +``` + +## Contributing + +We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to this project. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. + +## Contact + +For any questions or feedback, please reach out to us via GitHub issues or email. + +--- + +For more detailed information, including specific tool usage and examples, refer to the [README_CN.md](README_CN.md) file. \ No newline at end of file -- Gitee