diff --git a/README.md b/README.md index 02e71a9d65409a655e03552794432b3ce3336bd1..225ad90efef2cf64205f33fb068594130dd26229 100644 --- a/README.md +++ b/README.md @@ -1,187 +1,142 @@ # 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. +## Overview -## 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 +The Gitee Enterprise MCP Server is a powerful tool that provides programmatic access to Gitee Enterprise's features through a standardized API interface. It enables automation of various Gitee Enterprise operations including issue management, pull requests, repository operations, and more. -
-Scenario Example +## Features -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) -
+- **Comprehensive API Coverage**: Access to all major Gitee Enterprise features +- **Enterprise Management**: List enterprises, groups, members, and programs +- **Issue Tracking**: Create, update, comment on, and list issues +- **Pull Request Management**: Handle pull requests including creation, merging, and commenting +- **Repository Operations**: Manage repositories, releases, and file content +- **Scrum Tools**: Manage sprints and versions for agile development +- **Flexible Authentication**: Supports both bearer token and cookie-based authentication -## Installation(This step can be skipped directly when starting npx) +## Installation ### Prerequisites -- Go 1.23.0 or higher -- MCP token, [Go to get](https://gitee.com/profile/mcp_gitee_ent_access_tokens) +- Go 1.23 or higher +- Gitee Enterprise account with appropriate permissions ### Building from Source 1. Clone the repository: ```bash - git clone https://gitee.com/oschina/mcp-gitee-ent.git + git clone https://gitee.com/your-repo/mcp-gitee-ent.git cd mcp-gitee-ent ``` -2. Build the project: +2. Build the server: ```bash make build ``` - Move ./bin/mcp-gitee-ent PATH env -### Use go install +3. Alternatively, install using Go: ```bash - go install gitee.com/oschina/mcp-gitee-ent@latest + go install ``` -## Usage +### Docker -Check mcp-gitee-ent version: +You can also run the server using Docker: ```bash -mcp-gitee-ent --version +docker build -t mcp-gitee-ent . +docker run -p 8000:8000 mcp-gitee-ent ``` -## 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": "" - } - } - } -} +## Usage + +### Starting the Server + +```bash +./mcp-gitee-ent ``` -- executable -```json -{ - "mcpServers": { - "gitee-ent": { - "command": "mcp-gitee-ent", - "env": { - "GITEE_ENT_API_BASE": "https://api.gitee.com/enterprises", - "GITEE_ENT_MCP_ACCESS_TOKEN": "", - } - } - } -} + +By default, the server runs on port 8000. + +### Configuration + +Configure the server using environment variables or command-line flags: + +```bash +export GITEE_ACCESS_TOKEN=your_access_token +export API_BASE=https://your.gitee.enterprise/api +./mcp-gitee-ent ``` ### Command-line Options -- `--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 - -### Environment Variables - -You can also configure the server using environment variables: - -- `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 - -### Toolset Management - -Toolset management supports two modes: - -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"` - -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"` - -Note: -- If both `enabled-toolsets` and `disabled-toolsets` are specified, `enabled-toolsets` takes precedence -- Tool names are case-sensitive - -## Available Tools - -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. +- `--disabled-toolsets`: Comma-separated list of toolsets to disable +- `--enabled-toolsets`: Comma-separated list of toolsets to enable +- `--addr`: Address to listen on (default: ":8000") +- `--transport`: Transport protocol (default: "http") + +### Available Toolsets + +The server provides numerous toolsets for interacting with Gitee Enterprise: + +#### Enterprise Management +- List enterprises +- List enterprise groups +- List enterprise members +- List enterprise programs + +#### Issue Management +- Create, update, and comment on issues +- List issues and issue comments +- Get issue details +- Manage issue types and states + +#### Pull Request Management +- Create, update, merge pull requests +- List pull requests and comments +- Get pull request details and diffs + +#### Repository Operations +- Create repositories and releases +- List repositories and releases +- Get file content and repository tree + +#### Scrum Tools +- Create and list scrum sprints +- List scrum versions + +## Examples + +### Listing Issues + +```bash +curl -X POST http://localhost:8000/tools/ListIssues \ + -H "Content-Type: application/json" \ + -d '{"params": {"enterprise": "your-enterprise", "program": "your-program"}}' +``` + +### Creating a Pull Request + +```bash +curl -X POST http://localhost:8000/tools/CreateEntPull \ + -H "Content-Type: application/json" \ + -d '{"params": { + "enterprise": "your-enterprise", + "repository": "your-repo", + "title": "New feature", + "head": "feature-branch", + "base": "main" + }}' +``` + +## 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 terms of the [MIT License](LICENSE). + +## Support + +For support or questions, please open an issue in the repository. \ No newline at end of file