diff --git a/README.md b/README.md index 02e71a9d65409a655e03552794432b3ce3336bd1..7146fe93b4130bf714ffc4d18b220a626c8f9d30 100644 --- a/README.md +++ b/README.md @@ -1,187 +1,109 @@ # Gitee Enterprise MCP Server -Gitee Enterprise MCP Server is a Model Context Protocol (MCP) server implementation for Gitee Enterprise. It provides a set of tools for interacting with Gitee Enterprise API, allowing AI assistants to manage enterprise repositories, issues, pull requests, and more. +A [Model Controller Protocol (MCP)](https://github.com/openmcp/mcp) server implementation for Gitee Enterprise integration, enabling programmatic access to Gitee's API for repository management, issue tracking, CI/CD, and more. ## Features -- Interact with Gitee Enterprise repositories, issues, pull requests -- Support for enterprise-level operations and management -- Configurable API base URL to support different Gitee Enterprise instances -- Support for SSE and Stdio transport -- Dynamic toolset enable/disable +- **Repository Management**: Create/list repositories, manage releases, and access file content +- **Issue Tracking**: Create/update/list issues, comments, labels, and issue types/states +- **Pull Requests**: Create/manage PRs, review diffs, merge operations, and comments +- **Enterprise Tools**: Manage organizations, members, programs, and groups +- **Scrum Support**: Sprint and version management for agile workflows +- **Authentication**: Token-based and cookie-based authentication support -
-Scenario Example +## Installation -1. Get specific enterprise issues - ![get_issues](./docs/images/get_issues.png) -2. Improve the issue content - ![update_issue](./docs/images/update_issue.png) -3. Divide subtasks - ![create_sup_issues](./docs/images/create_sub_issues.png) -4. Create PR/Review PR - ![create_pr_and_review](./docs/images/pr_review.png) -
- -## Installation(This step can be skipped directly when starting npx) - -### Prerequisites - -- Go 1.23.0 or higher -- MCP token, [Go to get](https://gitee.com/profile/mcp_gitee_ent_access_tokens) +### Docker (Recommended) +```bash +docker build -t gitee-mcp-server . +docker run -p 8000:8000 gitee-mcp-server +``` -### Building from Source +### From Source +```bash +go mod download +go build -o mcp-gitee-ent main.go +./mcp-gitee-ent --transport tcp --addr :8000 +``` -1. Clone the repository: - ```bash - git clone https://gitee.com/oschina/mcp-gitee-ent.git - cd mcp-gitee-ent - ``` +### Binary Install +```bash +go install github.com/gitee-enterprise/mcp-gitee-ent@latest +``` -2. Build the project: - ```bash - make build - ``` - Move ./bin/mcp-gitee-ent PATH env +## Prerequisites -### Use go install - ```bash - go install gitee.com/oschina/mcp-gitee-ent@latest - ``` +- Gitee Enterprise account with API access +- Personal Access Token (classic) with appropriate permissions +- Go 1.23+ (for source builds) ## Usage -Check mcp-gitee-ent version: - +### Configuration +Set environment variables: ```bash -mcp-gitee-ent --version +export GITEE_ACCESS_TOKEN=your_token_here +export GITEE_API_BASE=https://your-gitee-instance.com/api/v5 ``` -## MCP Hosts Configuration -
- - - - - -
- -Config example: -- npx -```json -{ - "mcpServers": { - "gitee-ent": { - "command": "npx", - "args": [ - "-y", - "@gitee/mcp-gitee-ent@latest" - ], - "env": { - "GITEE_ENT_API_BASE": "https://api.gitee.com/enterprises", - "GITEE_ENT_MCP_ACCESS_TOKEN": "" - } - } - } -} +### Start Server +```bash +mcp-gitee-ent --transport tcp --addr :8000 ``` -- executable -```json -{ - "mcpServers": { - "gitee-ent": { - "command": "mcp-gitee-ent", - "env": { - "GITEE_ENT_API_BASE": "https://api.gitee.com/enterprises", - "GITEE_ENT_MCP_ACCESS_TOKEN": "", - } - } - } -} + +### MCP Client Configuration +Configure your MCP client to connect to: +```yaml +hosts: + - name: gitee-enterprise + url: http://localhost:8000 + capabilities: + - tools + - file-system ``` -### Command-line Options +## Available Tools -- `--token`: access token -- `--api-base`: Gitee Ent API base URL (default: https://api.gitee.com/enterprises) -- `--version`: Show version information -- `--transport`: Transport type (stdio or sse, default: stdio) -- `--sse-address`: The host and port to start the SSE server on (default: localhost:8000) -- `--enabled-toolsets`: Comma-separated list of tools to enable (if specified, only these tools will be enabled) -- `--disabled-toolsets`: Comma-separated list of tools to disable +### Repository Operations +- `CreateRepository`: Create new enterprise projects +- `ListRepositories`: List all enterprise repositories +- `GetFileContent`: Read file contents from repositories +- `CreateRelease`: Manage version releases -### Environment Variables +### Issue Management +- `CreateIssue`: Create new issues with labels/metadata +- `UpdateIssue`: Modify existing issues +- `ListIssues`: Query issues by filters +- `CommentIssue`: Add comments to issues -You can also configure the server using environment variables: +### Pull Requests +- `CreateEntPull`: Create pull requests +- `MergeEntPull`: Merge PRs programmatically +- `ListPullComments`: Retrieve PR discussion history -- `GITEE_ENT_MCP_ACCESS_TOKEN`: Gitee MCP ent access token -- `GITEE_ENT_API_BASE`: Gitee ENT API base URL -- `ENABLED_TOOLSETS`: Comma-separated list of tools to enable -- `DISABLED_TOOLSETS`: Comma-separated list of tools to disable +### Enterprise Management +- `ListEnterprises`: Query enterprise organizations +- `ListEntMembers`: Manage enterprise members +- `ListPrograms`: Access enterprise programs -### Toolset Management +### Scrum Tools +- `CreateScrumSprint`: Manage sprint planning +- `ListScrumVersions`: Track version milestones -Toolset management supports two modes: +## Contributing -1. Enable specified tools (whitelist mode): - - Use `--enabled-toolsets` parameter or `ENABLED_TOOLSETS` environment variable - - Specify after, only listed tools will be enabled, others will be disabled - - Example: `--enabled-toolsets="update_enterprise_issue,list_enterprise_repositories"` +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines and contribution process. We follow the [Contributor Covenant Code of Conduct](LICENSE). -2. Disable specified tools (blacklist mode): - - Use `--disabled-toolsets` parameter or `DISABLED_TOOLSETS` environment variable - - Specify after, listed tools will be disabled, others will be enabled - - Example: `--disabled-toolsets="update_enterprise_issue,list_enterprise_repositories"` +## License -Note: -- If both `enabled-toolsets` and `disabled-toolsets` are specified, `enabled-toolsets` takes precedence -- Tool names are case-sensitive +This project is licensed under the MIT License - see [LICENSE](LICENSE) file for details. -## Available Tools +## Contact + +For support or feature requests: +- Email: enterprise-support@gitee.com +- GitHub Issues: https://github.com/gitee-enterprise/mcp-gitee-ent/issues + +--- -The server provides various tools for interacting with Gitee Enterprise: - -| Tool | Category | Description | -|----------------------------------------|---------------|-------------| -| **list_enterprises** | Enterprise | List user's enterprises | -| **list_enterprise_repositories** | Repository | List repositories in an enterprise | -| **create_enterprise_repository** | Repository | Create a repository in an enterprise | -| **create_enterprise_repo_release** | Repository | Create a release for repository | -| **list_enterprise_repo_releases** | Repository | List releases for repository | -| **get_enterprise_repository_file_content** | Repository | Get the content of a specific file in the repository | -| **get_enterprise_repo_tree** | Repository | Get the tree structure of a repository | -| **list_enterprise_pulls** | Pull Request | List enterprise pull requests | -| **create_enterprise_repo_pull** | Pull Request | Create a pull request for repository | -| **merge_enterprise_pull** | Pull Request | Merge a pull request | -| **get_enterprise_pull_detail** | Pull Request | Get pull request detail | -| **update_enterprise_pull** | Pull Request | Update a pull request | -| **get_enterprise_pull_diff** | Pull Request | Get pull request diff | -| **comment_enterprise_pull** | Pull Request | Comment on a pull request | -| **list_enterprise_pull_comments** | Pull Request | List pull request comments | -| **create_enterprise_issue** | Issue | Create an issue | -| **update_enterprise_issue** | Issue | Update an issue | -| **get_enterprise_issue_detail** | Issue | Get issue detail | -| **list_enterprise_issues** | Issue | List issues | -| **comment_enterprise_issue** | Issue | Comment on an issue | -| **list_enterprise_issue_comments** | Issue | List issue comments | -| **get_user_info** | User | Get user info | -| **list_enterprise_members** | Member | List members of an enterprise | -| **list_enterprise_groups** | Group | List groups in an enterprise | -| **list_enterprise_labels** | Label | List labels of an enterprise | -| **list_programs** | Program | List programs of an enterprise | -| **list_scrum_sprints** | Program | List Scrum Sprints | -| **create_scrum_sprint** | Program | Create a Scrum Sprint | -| **list_scrum_versions** | Program | List Scrum Versions | -| **list_issue_types** | Issue Type | List issue types | -| **list_issue_type_states** | Issue State | List issue states | - -## Contribution - -We welcome contributions from the open-source community! If you'd like to contribute to this project, please follow these guidelines: - -1. Fork the repository. -2. Create a new branch for your feature or bug fix. -3. Make your changes and ensure the code is well-documented. -4. Submit a pull request with a clear description of your changes. - -For more information, please refer to the [CONTRIBUTING](CONTRIBUTING.md) file. +*Gitee Enterprise MCP Server connects your infrastructure to Gitee's enterprise-grade DevOps platform.* \ No newline at end of file