From a4c8208cd5ee3e966b8fe662753105db6c0142a4 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Tue, 27 May 2025 06:13:04 +0000 Subject: [PATCH] Update README.md --- README.md | 253 +++++++++++++++++++----------------------------------- 1 file changed, 88 insertions(+), 165 deletions(-) diff --git a/README.md b/README.md index 02e71a9..698efb6 100644 --- a/README.md +++ b/README.md @@ -1,187 +1,110 @@ +```markdown # 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 server implementation for Gitee Enterprise's Microservice Command Protocol (MCP), providing a comprehensive set of tools for interacting with Gitee Enterprise's API. ## 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 - -
-Scenario Example - -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) +- **Enterprise Management**: + - List enterprises, members, groups, and programs +- **Issue Tracking**: + - Create, update, comment on, and list issues + - Manage issue states and types +- **Pull Request Management**: + - Create, update, merge, and comment on pull requests + - View pull request details and diffs +- **Repository Operations**: + - List, create repositories + - Manage releases and repository contents +- **Scrum Management**: + - Create and list sprints and versions +- **Utility Operations**: + - Get user information + - Manage labels and file contents + +## 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+ (for building from source) +- Docker (for containerized deployment) ### Building from Source +```bash +git clone +cd mcp-gitee-ent +go build -o mcp-gitee-ent +``` -1. Clone the repository: - ```bash - git clone https://gitee.com/oschina/mcp-gitee-ent.git - cd mcp-gitee-ent - ``` - -2. Build the project: - ```bash - make build - ``` - Move ./bin/mcp-gitee-ent PATH env +### Using go install +```bash +go install github.com/gitee-enterprise/mcp-gitee-ent@latest +``` -### Use go install - ```bash - go install gitee.com/oschina/mcp-gitee-ent@latest - ``` +### Docker +```bash +docker build -t mcp-gitee-ent . +docker run -p 8000:8000 mcp-gitee-ent +``` ## Usage -Check mcp-gitee-ent version: +### Basic Configuration +Configure your Gitee Enterprise access token: +```bash +export GITEE_ACCESS_TOKEN=your_access_token +export MCP_API_BASE=https://your.gitee.enterprise.api +``` +### Starting the Server ```bash -mcp-gitee-ent --version +./mcp-gitee-ent --addr :8000 ``` -## 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": "" - } - } - } -} +### Command-line Options ``` -- executable -```json -{ - "mcpServers": { - "gitee-ent": { - "command": "mcp-gitee-ent", - "env": { - "GITEE_ENT_API_BASE": "https://api.gitee.com/enterprises", - "GITEE_ENT_MCP_ACCESS_TOKEN": "", - } - } - } -} +--addr string Server address to listen on (default ":8000") +--disabled-toolsets Comma-separated list of toolsets to disable +--enabled-toolsets Comma-separated list of toolsets to enable ``` -### Command-line Options +### API Usage Examples +The server exposes a set of tools that can be called via MCP protocol. Refer to the operations directory for the complete list of available tools. + +Example tool calls: +- List issues in a repository +- Create a new pull request +- Get repository file contents + +## Toolset Management + +### Available Toolsets +The server provides tools organized in these categories: +- `enterprise`: Enterprise management tools +- `issues`: Issue tracking tools +- `pulls`: Pull request tools +- `repository`: Repository operations +- `scrum`: Scrum management tools +- `user`: User information tools + +### Enabling/Disabling Tools +Tools can be selectively enabled or disabled using command-line flags: +```bash +# Run with only issue-related tools +./mcp-gitee-ent --enabled-toolsets=issues + +# Disable scrum-related tools +./mcp-gitee-ent --disabled-toolsets=scrum +``` + +## 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 [LICENSE](LICENSE) file. + +## Support -- `--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. +For help with installation or usage, please open an issue in the project repository. +``` \ No newline at end of file -- Gitee