diff --git a/README.md b/README.md index 02e71a9d65409a655e03552794432b3ce3336bd1..5e63d82cd028fac28155298037f2156eda1f2480 100644 --- a/README.md +++ b/README.md @@ -1,187 +1,93 @@ # 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. +Gitee Enterprise MCP Server 是一个为 Gitee 企业版设计的 Model Control Plane (MCP) 服务器。它提供了一系列工具，用于与 Gitee 平台进行交互和管理。 ## 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 +- 提供与 Gitee 企业版平台交互的 API +- 支持多种操作，包括但不限于： + - 问题管理（创建、更新、评论等） + - 仓库管理（创建、获取文件内容、获取树结构等） + - 拉取请求管理（创建、更新、合并等） + - 用户和成员管理 + - 标签、冲刺、版本管理 +- 支持通过命令行选项和环境变量进行配置 +- 支持工具集管理，可以启用或禁用特定工具集 -
-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) +## 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 或更高版本 +- Docker（可选，用于构建镜像） ### Building from Source -1. Clone the repository: +1. 克隆仓库： ```bash - git clone https://gitee.com/oschina/mcp-gitee-ent.git + git clone https://github.com/gitee/mcp-gitee-ent.git cd mcp-gitee-ent ``` -2. Build the project: +2. 构建项目： ```bash - make build + go build -o mcp-gitee-ent main.go ``` - Move ./bin/mcp-gitee-ent PATH env ### Use go install - ```bash - go install gitee.com/oschina/mcp-gitee-ent@latest - ``` - -## Usage - -Check mcp-gitee-ent version: ```bash -mcp-gitee-ent --version +go install github.com/gitee/mcp-gitee-ent@latest ``` -## 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": "", - } - } - } -} -``` +## Usage + +### MCP Hosts Configuration + +确保你的 MCP 客户端配置了正确的主机地址。 ### 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 +- `-transport`: 指定传输协议（默认: "tcp"） +- `-addr`: 指定监听地址（默认: ":8000"） +- `-disabled-toolsets`: 禁用的工具集列表 +- `-enabled-toolsets`: 启用的工具集列表 ### 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 +- `GITEE_ACCESS_TOKEN`: Gitee 访问令牌 +- `API_BASE`: 自定义 API 基础 URL ### 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"` +- 禁用工具集： + ```bash + ./mcp-gitee-ent -disabled-toolsets=issue,repository + ``` -Note: -- If both `enabled-toolsets` and `disabled-toolsets` are specified, `enabled-toolsets` takes precedence -- Tool names are case-sensitive +- 启用工具集： + ```bash + ./mcp-gitee-ent -enabled-toolsets=user,enterprise + ``` ## 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 | +- **Issue Management**: 创建、更新、评论、获取问题详情等 +- **Repository Management**: 创建仓库、获取文件内容、获取树结构等 +- **Pull Request Management**: 创建、更新、合并拉取请求等 +- **User and Member Management**: 获取用户信息、列出企业成员等 +- **Label, Sprint, Version Management**: 管理标签、冲刺和版本 ## Contribution -We welcome contributions from the open-source community! If you'd like to contribute to this project, please follow these guidelines: +我们欢迎贡献！请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 了解如何为项目做贡献。 + +## License + +本项目采用 MIT 许可证。详情请参阅 [LICENSE](LICENSE) 文件。 -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. +## Contact -For more information, please refer to the [CONTRIBUTING](CONTRIBUTING.md) file. +如果你有任何问题或建议，请联系项目维护者。 \ No newline at end of file