diff --git a/README.md b/README.md index 02e71a9d65409a655e03552794432b3ce3336bd1..fae157db3d4a5026a5a576cc4ec318a58b7f2830 100644 --- a/README.md +++ b/README.md @@ -1,187 +1,98 @@ -# 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. -## Features +# Gitee Enterprise MCP Server -- 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 +> MCP (Model Connector Protocol) 服务器实现，专为 Gitee Enterprise 设计，用于与 AI 工具集成并提供项目管理、代码协作等功能。 -
-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) -
+- 支持与 Gitee Enterprise 的深度集成 +- 提供 Issues、Pull Requests、Repositories、Labels、Programs 等多种工具 +- 支持 Scrum 敏捷开发流程（Sprints 和 Versions） +- 提供用户认证和权限管理 +- 支持通过 MCP 协议进行工具调用 -## 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 或更高版本（用于从源码构建） +- Node.js（用于使用 npm 安装） +- Gitee 企业版账号及访问权限 ### Building from Source -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 +```bash +git clone https://github.com/your-repo/gitee-mcp-server.git +cd gitee-mcp-server +make build +``` ### 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 客户端（如 Cursor、Windsurf 等）配置了正确的服务器地址和端口（默认 `localhost: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": "" - } - } - } -} -``` -- executable -```json -{ - "mcpServers": { - "gitee-ent": { - "command": "mcp-gitee-ent", - "env": { - "GITEE_ENT_API_BASE": "https://api.gitee.com/enterprises", - "GITEE_ENT_MCP_ACCESS_TOKEN": "", - } - } - } -} +### Command-line Options + +```bash +./mcp-gitee-ent --help ``` -### 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_ACCESS_TOKEN`：设置 Gitee 企业版访问令牌 +- `API_BASE`：设置 Gitee 企业版 API 地址（默认为 `https://gitee.com/api/v5/`） ### 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 | +#### Available Tools + +- `list-enterprises`：列出企业信息 +- `list-projects`：列出项目 +- `list-issues`：列出 Issues +- `create-issue`：创建 Issue +- `update-issue`：更新 Issue +- `comment-issue`：评论 Issue +- `list-issue-comments`：列出 Issue 的评论 +- `list-issue-types`：列出 Issue 类型 +- `list-issue-type-states`：列出 Issue 状态 +- `list-repositories`：列出仓库 +- `create-repository`：创建仓库 +- `list-releases`：列出发布版本 +- `create-release`：创建发布版本 +- `list-pulls`：列出 Pull Requests +- `create-pull`：创建 Pull Request +- `merge-pull`：合并 Pull Request +- `update-pull`：更新 Pull Request +- `comment-pull`：评论 Pull Request +- `list-pull-comments`：列出 Pull Request 的评论 +- `get-pull-diff`：获取 Pull Request 的 Diff +- `list-scrum-sprints`：列出 Scrum Sprints +- `create-scrum-sprint`：创建 Scrum Sprint +- `list-scrum-versions`：列出 Scrum Versions +- `list-members`：列出企业成员 ## 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](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. +如有任何问题或建议，请提交 Issue 或联系项目维护者。 \ No newline at end of file