From 63003dc7589fa89a1336983d4d14be972e7d4e55 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 13 Jun 2025 06:33:59 +0000 Subject: [PATCH] Update README.md --- README.en.md | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 234 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..9fcd75d --- /dev/null +++ b/README.en.md @@ -0,0 +1,117 @@ +# Gitee MCP Server + +Gitee MCP (Multi-Cloud Platform) Server is a tool that provides integration between Gitee Enterprise and various IDEs and code tools that support the MCP protocol. It acts as a bridge, enabling seamless interaction between development tools and Gitee Enterprise services. + +## Features + +- **Issue Management**: Create, update, comment on, and list issues +- **Pull Request Handling**: Create, update, merge, and list pull requests +- **Repository Operations**: Create repositories, get file content, list repositories +- **Enterprise Management**: List enterprises, programs, members, and groups +- **Scrum Support**: Manage sprints and versions in Scrum methodology +- **Label and State Management**: List issue types, states, and labels + +## Installation + +### From Source + +1. Install Go 1.23 or later +2. Clone this repository +3. Build the server: + ```bash + make build + ``` +4. Run the server: + ```bash + ./mcp-gitee-ent + ``` + +### Using Docker + +```bash +docker build -t gitee-mcp-server . +docker run -p 8000:8000 gitee-mcp-server +``` + +## Usage + +### Starting the Server + +The server can be started with the following command: + +```bash +./mcp-gitee-ent +``` + +By default, the server listens on port 8000. You can change this using the `--addr` flag: + +```bash +./mcp-gitee-ent --addr=:9000 +``` + +### Environment Variables + +- `GITEE_ACCESS_TOKEN`: Set your Gitee access token for authentication +- `GITEE_API_BASE`: Set a custom Gitee API base URL if needed + +### Command Line Options + +- `--disabled-tools`: Comma-separated list of tools to disable +- `--enabled-tools`: Comma-separated list of tools to enable + +## Available Tools + +The server provides a comprehensive set of tools for interacting with Gitee Enterprise: + +### Enterprise Management +- List enterprises +- List enterprise members +- List enterprise labels + +### Repository Operations +- Create repositories +- List repositories +- Get file content +- Get repository tree +- Create releases +- List releases + +### Issue Management +- Create issues +- Get issue details +- Update issues +- List issues +- Comment on issues +- List issue comments +- List issue types +- List issue type states + +### Pull Request Handling +- Create pull requests +- Get pull request details +- Get pull request diff +- Update pull requests +- List pull requests +- Comment on pull requests +- List pull request comments +- Merge pull requests + +### Scrum Support +- Manage sprints (create, list) +- Manage versions (list) + +### User and Group Management +- Get user information +- List groups + +## Contributing + +We welcome contributions to the Gitee MCP Server project. Please see our [Contributing Guide](CONTRIBUTING.md) for more information on how to contribute. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. + +## Contact + +For questions or feedback, please open an issue on the GitHub/Gitee repository or contact the maintainers directly. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9fcd75d --- /dev/null +++ b/README.md @@ -0,0 +1,117 @@ +# Gitee MCP Server + +Gitee MCP (Multi-Cloud Platform) Server is a tool that provides integration between Gitee Enterprise and various IDEs and code tools that support the MCP protocol. It acts as a bridge, enabling seamless interaction between development tools and Gitee Enterprise services. + +## Features + +- **Issue Management**: Create, update, comment on, and list issues +- **Pull Request Handling**: Create, update, merge, and list pull requests +- **Repository Operations**: Create repositories, get file content, list repositories +- **Enterprise Management**: List enterprises, programs, members, and groups +- **Scrum Support**: Manage sprints and versions in Scrum methodology +- **Label and State Management**: List issue types, states, and labels + +## Installation + +### From Source + +1. Install Go 1.23 or later +2. Clone this repository +3. Build the server: + ```bash + make build + ``` +4. Run the server: + ```bash + ./mcp-gitee-ent + ``` + +### Using Docker + +```bash +docker build -t gitee-mcp-server . +docker run -p 8000:8000 gitee-mcp-server +``` + +## Usage + +### Starting the Server + +The server can be started with the following command: + +```bash +./mcp-gitee-ent +``` + +By default, the server listens on port 8000. You can change this using the `--addr` flag: + +```bash +./mcp-gitee-ent --addr=:9000 +``` + +### Environment Variables + +- `GITEE_ACCESS_TOKEN`: Set your Gitee access token for authentication +- `GITEE_API_BASE`: Set a custom Gitee API base URL if needed + +### Command Line Options + +- `--disabled-tools`: Comma-separated list of tools to disable +- `--enabled-tools`: Comma-separated list of tools to enable + +## Available Tools + +The server provides a comprehensive set of tools for interacting with Gitee Enterprise: + +### Enterprise Management +- List enterprises +- List enterprise members +- List enterprise labels + +### Repository Operations +- Create repositories +- List repositories +- Get file content +- Get repository tree +- Create releases +- List releases + +### Issue Management +- Create issues +- Get issue details +- Update issues +- List issues +- Comment on issues +- List issue comments +- List issue types +- List issue type states + +### Pull Request Handling +- Create pull requests +- Get pull request details +- Get pull request diff +- Update pull requests +- List pull requests +- Comment on pull requests +- List pull request comments +- Merge pull requests + +### Scrum Support +- Manage sprints (create, list) +- Manage versions (list) + +### User and Group Management +- Get user information +- List groups + +## Contributing + +We welcome contributions to the Gitee MCP Server project. Please see our [Contributing Guide](CONTRIBUTING.md) for more information on how to contribute. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. + +## Contact + +For questions or feedback, please open an issue on the GitHub/Gitee repository or contact the maintainers directly. \ No newline at end of file -- Gitee