diff --git a/README.md b/README.md index 02e71a9d65409a655e03552794432b3ce3336bd1..48c12b4fd14cd078a3c7fa3d4c499db84ff2e382 100644 --- a/README.md +++ b/README.md @@ -1,187 +1,123 @@ + + # 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 Multi-Codebase Protocol (MCP) server implementation for Gitee Enterprise, enabling seamless integration and management across multiple codebases. -## 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 +## Features -
-Scenario Example +- **Multi-Codebase Management**: Operate across multiple codebases with unified tooling. +- **Gitee Enterprise Integration**: Direct support for Gitee Enterprise features. +- **Toolset Customization**: Enable or disable specific tools as per your requirements. +- **Comprehensive Operations**: Supports a wide range of operations including: + - Issue management (create, update, list, comment) + - Pull request management (create, update, merge, diff) + - Repository operations (list, create, release management) + - Enterprise resource access (members, groups, programs, scrum sprints, versions) -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) +## 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 later +- Docker (if using the Dockerfile for deployment) ### Building from Source -1. Clone the repository: - ```bash - git clone https://gitee.com/oschina/mcp-gitee-ent.git - cd mcp-gitee-ent - ``` +```bash +git clone https://github.com/your-repo/gitee-mcp-server.git +cd gitee-mcp-server +make build +``` -2. Build the project: - ```bash - make build - ``` - Move ./bin/mcp-gitee-ent PATH env +### Use `go install` -### Use go install - ```bash - go install gitee.com/oschina/mcp-gitee-ent@latest - ``` +```bash +go install github.com/your-repo/gitee-mcp-server@latest +``` + +--- ## Usage -Check mcp-gitee-ent version: +### MCP Hosts Configuration -```bash -mcp-gitee-ent --version -``` - -## 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": "" - } - } - } -} -``` -- executable -```json -{ - "mcpServers": { - "gitee-ent": { - "command": "mcp-gitee-ent", - "env": { - "GITEE_ENT_API_BASE": "https://api.gitee.com/enterprises", - "GITEE_ENT_MCP_ACCESS_TOKEN": "", - } - } - } -} -``` +Ensure you have configured the correct MCP host endpoints in your environment or config files. ### 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 +The server can be started using: -### Environment Variables +```bash +mcp-gitee-ent [transport] [address] +``` + +Where: +- `transport`: The transport protocol (e.g., `tcp`, `http`) +- `address`: The address to bind (e.g., `:8000`) -You can also configure the server using environment variables: +### 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 +- `GITEE_ACCESS_TOKEN`: Set your Gitee access token. +- `API_BASE_URL`: Customize the Gitee API base URL if needed. ### 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 | +You can control enabled/disabled toolsets using flags: + +- `-disable_toolsets`: Comma-separated list of toolsets to disable +- `-enable_toolsets`: Comma-separated list of toolsets to enable + +### Available Tools + +| Tool | Description | +|------|-------------| +| `create_issue` | Create a new issue in a project | +| `update_issue` | Update an existing issue | +| `list_issues` | List all issues in a project | +| `comment_issue` | Add a comment to an issue | +| `list_issue_comments` | List all comments on an issue | +| `create_pull` | Create a pull request | +| `merge_pull` | Merge a pull request | +| `list_pulls` | List all pull requests in a repository | +| `get_pull_diff` | Get the diff of a pull request | +| `list_releases` | List all releases for a repository | +| `create_release` | Create a new release | +| `list_enterprises` | List enterprises the user belongs to | +| `get_user_info` | Get current user information | +| `list_ent_groups` | List enterprise groups | +| `list_ent_members` | List enterprise members | +| `list_programs` | List programs within an enterprise | +| `list_scrum_sprints` | List Scrum sprints | +| `list_scrum_versions` | List Scrum versions | +| `list_labels` | List enterprise labels | +| `list_issue_types` | List issue types | +| `list_issue_states` | List issue states | +| `get_file_content` | Retrieve file content from a repository | +| `get_repo_tree` | Get the file tree of a repository | + +--- ## Contribution -We welcome contributions from the open-source community! If you'd like to contribute to this project, please follow these guidelines: +We welcome contributions! Please follow the [CONTRIBUTING.md](CONTRIBUTING.md) guidelines to get started. + +--- + +## License + +This project is licensed under the [LICENSE](LICENSE) file's terms. + +--- + +## Contact + +For questions or support, please reach out to the maintainers via [Contact Information](README.md#contact). -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. +For more details on specific tools or functionalities, explore the individual operation files under the `operations/` directory. \ No newline at end of file