diff --git a/README.md b/README.md index 02e71a9d65409a655e03552794432b3ce3336bd1..4df9d2e41b13eeb88e6e88eb42c83aca472c1116 100644 --- a/README.md +++ b/README.md @@ -1,187 +1,87 @@ # 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 Controller Proxy (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 +- **全面的 API 支持**：支持 Gitee 企业版的各种 API，包括但不限于问题管理、仓库管理、拉取请求、Scrum 管理等。 +- **灵活的认证机制**：支持 Bearer Token 和 Cookie 认证方式。 +- **错误处理**：提供详细的错误类型和处理机制，便于调试和日志记录。 +- **参数验证**：确保传入的参数符合预期，避免无效请求。 +- **跨平台支持**：提供适用于不同操作系统的二进制文件，包括 Darwin (AMD64/ARM64)、Linux (AMD64/ARM64) 和 Windows (AMD64/ARM64)。 -
-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 +3. 运行服务： ```bash - go install gitee.com/oschina/mcp-gitee-ent@latest + ./mcp-gitee-ent ``` -## Usage - -Check mcp-gitee-ent version: +### Use go install ```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 + +确保在使用前配置好 Gitee 的 API 基础 URL 和访问令牌： + +```go +utils.SetApiBase("https://your-gitee-api-base-url") +utils.SetGiteeAccessToken("your-access-token") ``` ### 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`） ### 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_API_BASE`: Gitee API 基础 URL +- `GITEE_ACCESS_TOKEN`: Gitee 访问令牌 ### 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 | +可以通过命令行参数 `--disabled-toolsets` 和 `--enabled-toolsets` 来管理工具集的启用和禁用。 + +### Available Tools + +- **企业版管理**：列出企业、创建仓库、管理成员等。 +- **问题管理**：创建问题、更新问题、评论问题、列出问题等。 +- **拉取请求管理**：创建拉取请求、更新拉取请求、合并拉取请求等。 +- **Scrum 管理**：管理 Scrum 冲刺和版本。 +- **仓库管理**：获取文件内容、列出仓库、创建发布等。 ## 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. +如有任何问题或建议，请联系 [edmondfrank@example.com](mailto:edmondfrank@example.com)。 \ No newline at end of file