cann-gitcode-mcp 0.1.0__tar.gz

cann_gitcode_mcp-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Virtual environment
+venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# Environment
+.env

cann_gitcode_mcp-0.1.0/AGENTS.md

@@ -0,0 +1,133 @@
+# AGENTS.md — cann-gitcode-mcp
+
+Guidelines for AI agents (and humans) contributing to this repository.
+
+## Project Purpose
+
+`cann-gitcode-mcp` wraps the GitCode REST API (v5) as an MCP server so that AI assistants (Claude Code, etc.) can perform GitCode operations on behalf of CANN developers. Current scope: Pull Request management. Planned: CI/pipeline tools, repository tools, Issue tools.
+
+## Repository Structure
+
+```
+cann-gitcode-mcp/
+├── src/cann_gitcode_mcp/
+│   ├── __init__.py          # Package metadata
+│   ├── __main__.py          # Entry point: python -m cann_gitcode_mcp
+│   ├── server.py            # FastMCP instance; wires all tool modules
+│   ├── client.py            # GitCodeClient (async httpx wrapper)
+│   └── tools/
+│       ├── __init__.py
+│       └── pull_request.py  # 6 PR tools
+├── tests/
+│   ├── test_pull_request.py
+│   └── test_server.py
+├── pyproject.toml
+├── README.md
+├── CLAUDE.md
+└── AGENTS.md
+```
+
+## Setup
+
+```bash
+# Activate the virtual environment (if using the repo's venv)
+source venv/bin/activate
+
+# Install the package with development dependencies
+uv pip install -e ".[dev]"
+```
+
+If `uv` is not available, use:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Python >= 3.11 is required.
+
+## Running Tests
+
+```bash
+pytest tests/ -v
+```
+
+All tests are unit tests that mock network calls — no real API token is needed.
+
+## API Client
+
+`GitCodeClient` (in `src/cann_gitcode_mcp/client.py`) is the only HTTP layer.
+
+- **Auto-reads token**: reads `GITCODE_API_TOKEN` from the environment on construction. Raises `ValueError` if unset.
+- **Base URL**: `https://gitcode.com/api/v5` (override with `GITCODE_API_BASE_URL`).
+- **Methods**: `get`, `post`, `patch`, `put`, `delete` — all async, return parsed JSON or `None` (for 204).
+- **Error handling**: raises `RuntimeError` on non-2xx responses with the status code and body.
+
+Example usage in a tool:
+
+```python
+client = GitCodeClient()  # reads GITCODE_API_TOKEN from env
+data = await client.get("/repos/owner/repo/pulls/1")
+data = await client.post("/repos/owner/repo/pulls", json={"title": "fix", "head": "dev", "base": "main"})
+```
+
+## How to Add a New Tool
+
+Follow these steps exactly:
+
+### 1. Create the tool file
+
+Create `src/cann_gitcode_mcp/tools/<domain>.py`. The file must:
+
+- Import `FastMCP` from `mcp.server.fastmcp` and `GitCodeClient` from `cann_gitcode_mcp.client`.
+- Define a module-level `_client: GitCodeClient | None = None` and a `_get_client()` helper.
+- Define a single public function `register_<domain>_tools(mcp: FastMCP) -> None`.
+- Inside that function, define each tool as an `async def` decorated with `@mcp.tool()`.
+
+Rules for tool functions:
+- Must be `async def`.
+- Must return `str` (JSON, produced with `json.dumps(..., ensure_ascii=False)`).
+- Must have a docstring — the first line is the MCP tool description; use `Args:` sections for parameters.
+- Must include type annotations on all parameters.
+
+### 2. Register in server.py
+
+Add two lines to `src/cann_gitcode_mcp/server.py`:
+
+```python
+from cann_gitcode_mcp.tools.<domain> import register_<domain>_tools
+register_<domain>_tools(mcp)
+```
+
+### 3. Add tests
+
+Create `tests/test_<domain>.py`. Use `unittest.mock.AsyncMock` / `patch` to mock `GitCodeClient` methods. Never make real HTTP requests in tests.
+
+Pattern for accessing a registered tool function:
+
+```python
+tool_fn = mcp_server._tool_manager._tools["<tool_name>"].fn
+result = await tool_fn(owner="org", repo="repo", ...)
+```
+
+### 4. Run tests
+
+```bash
+pytest tests/ -v
+```
+
+All existing and new tests must pass before committing.
+
+## Important Constraints
+
+- **All tool functions must be `async def`** — synchronous tools will fail at runtime.
+- **Return type is always `str`** — serialize with `json.dumps(result, indent=2, ensure_ascii=False)`.
+- **Registration pattern** — tools must be registered via `@mcp.tool()` inside a `register_*_tools(mcp)` function; do not call `mcp.tool()` at module import time.
+- **No global state beyond `_client`** — the module-level `_client` singleton is reset between test fixtures via `patch`.
+- **Token is required** — `GitCodeClient()` raises `ValueError` if `GITCODE_API_TOKEN` is not set; tests must patch the env or the client.
+
+## GitCode API Reference
+
+- Base URL: `https://gitcode.com/api/v5`
+- Authentication: `Authorization: Bearer <token>` header
+- PR endpoints: `/repos/{owner}/{repo}/pulls[/{number}[/merge|comments|files]]`
+- Full API docs: consult GitCode platform documentation

cann_gitcode_mcp-0.1.0/CLAUDE.md

@@ -0,0 +1,132 @@
+# CLAUDE.md — cann-gitcode-mcp
+
+## Project Overview
+
+`cann-gitcode-mcp` is an MCP (Model Context Protocol) server that exposes GitCode API operations as MCP tools for CANN developers. It wraps GitCode's REST API (v5, base URL `https://gitcode.com/api/v5`) so that Claude Code and other MCP clients can perform GitCode actions (create PRs, list PRs, merge, comment, etc.) directly from a conversation. The package name is `cann-gitcode-mcp`; the importable Python module is `cann_gitcode_mcp`.
+
+## Architecture
+
+```
+src/cann_gitcode_mcp/
+├── __init__.py          # Package version / public exports
+├── __main__.py          # python -m cann_gitcode_mcp entry point → calls server.main()
+├── server.py            # FastMCP instance + wires in all tool modules
+├── client.py            # GitCodeClient: async HTTP client wrapping httpx
+└── tools/
+    ├── __init__.py
+    └── pull_request.py  # register_pull_request_tools(mcp) — 6 PR tools
+```
+
+- **`server.py`** — creates the `FastMCP("gitcode")` instance and calls every `register_*_tools(mcp)` function. This is the single wiring point.
+- **`client.py`** — `GitCodeClient` reads `GITCODE_API_TOKEN` from the environment, sets up an `httpx.AsyncClient`, and provides `get / post / patch / put / delete` async helpers.
+- **`tools/`** — each file owns one domain (pull requests, issues, repos, …). Tools are registered via `@mcp.tool()` inside a `register_*_tools(mcp: FastMCP)` function.
+
+## Adding New Tools
+
+1. Create `src/cann_gitcode_mcp/tools/<domain>.py`.
+2. Define `register_<domain>_tools(mcp: FastMCP) -> None` that decorates each async function with `@mcp.tool()`.
+3. Import and call the registration function in `server.py`.
+4. Add tests in `tests/test_<domain>.py` (see Testing Patterns below).
+
+Example skeleton:
+
+```python
+# src/cann_gitcode_mcp/tools/issue.py
+from __future__ import annotations
+import json
+from mcp.server.fastmcp import FastMCP
+from cann_gitcode_mcp.client import GitCodeClient
+
+_client: GitCodeClient | None = None
+
+def _get_client() -> GitCodeClient:
+    global _client
+    if _client is None:
+        _client = GitCodeClient()
+    return _client
+
+def register_issue_tools(mcp: FastMCP) -> None:
+
+    @mcp.tool()
+    async def get_issue(owner: str, repo: str, number: int) -> str:
+        """Get details of a GitCode issue.
+
+        Args:
+            owner: Repository namespace
+            repo: Repository name
+            number: Issue number
+        """
+        client = _get_client()
+        result = await client.get(f"/repos/{owner}/{repo}/issues/{number}")
+        return json.dumps(result, indent=2, ensure_ascii=False)
+```
+
+Then in `server.py`:
+
+```python
+from cann_gitcode_mcp.tools.issue import register_issue_tools
+register_issue_tools(mcp)
+```
+
+## Development Commands
+
+```bash
+# Install with dev dependencies
+uv pip install -e ".[dev]"
+
+# Run the test suite
+pytest
+
+# Run with verbose output
+pytest -v
+
+# Start the MCP server (stdio transport)
+python -m cann_gitcode_mcp
+```
+
+## Code Style
+
+- **Python 3.11+** — use `X | Y` union types, `from __future__ import annotations` at the top of every file.
+- **Async** — all tool functions must be `async def`.
+- **Type hints** — all function parameters and return types must be annotated.
+- **Docstrings** — every tool function must have a docstring; the first line becomes the MCP tool description. Use `Args:` sections for parameter documentation.
+- **Return type** — all tools return `str` (JSON-serialised with `json.dumps(..., ensure_ascii=False)`).
+- **No bare exceptions** — let errors propagate from `GitCodeClient`; the MCP framework will surface them to the client.
+
+## Testing Patterns
+
+Tests live in `tests/`. The project uses `pytest-asyncio` with `asyncio_mode = "auto"`.
+
+Key pattern — mock `GitCodeClient` methods so tests never hit the network:
+
+```python
+import pytest
+from unittest.mock import AsyncMock, patch
+from mcp.server.fastmcp import FastMCP
+from cann_gitcode_mcp.tools.pull_request import register_pull_request_tools
+
+@pytest.fixture
+def mcp_server():
+    server = FastMCP("test")
+    with patch("cann_gitcode_mcp.tools.pull_request._client", None), \
+         patch.dict("os.environ", {"GITCODE_API_TOKEN": "test-token"}):
+        register_pull_request_tools(server)
+        yield server
+
+async def test_get_pull_request(mcp_server):
+    tool_fn = mcp_server._tool_manager._tools["get_pull_request"].fn
+    fake_pr = {"number": 1, "title": "fix: something"}
+    with patch("cann_gitcode_mcp.tools.pull_request.GitCodeClient.get",
+               new_callable=AsyncMock, return_value=fake_pr):
+        result = await tool_fn(owner="org", repo="repo", number=1)
+    assert '"number": 1' in result
+```
+
+Use `mcp_server._tool_manager._tools["<tool_name>"].fn` to get the raw async callable for a registered tool.
+
+## Environment
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `GITCODE_API_TOKEN` | Yes | Personal access token from GitCode settings |
+| `GITCODE_API_BASE_URL` | No | Override API base (default: `https://gitcode.com/api/v5`) |

cann_gitcode_mcp-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 shengnan
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cann_gitcode_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: cann-gitcode-mcp
+Version: 0.1.0
+Summary: CANN GitCode MCP Server - GitCode platform tools for CANN developers
+Project-URL: Homepage, https://gitcode.com/shengnan666/cann-gitcode-mcp
+Project-URL: Repository, https://gitcode.com/shengnan666/cann-gitcode-mcp
+Project-URL: Issues, https://gitcode.com/shengnan666/cann-gitcode-mcp/issues
+Author-email: shengnan <shengnan1126@yeah.net>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cann,gitcode,mcp,model-context-protocol
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: mcp>=1.0
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: twine>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# cann-gitcode-mcp
+
+[![PyPI version](https://img.shields.io/pypi/v/cann-gitcode-mcp)](https://pypi.org/project/cann-gitcode-mcp/)
+[![Python](https://img.shields.io/pypi/pyversions/cann-gitcode-mcp)](https://pypi.org/project/cann-gitcode-mcp/)
+[![License](https://img.shields.io/pypi/l/cann-gitcode-mcp)](https://github.com/shengnan666/cann-gitcode-mcp/blob/main/LICENSE)
+
+CANN GitCode MCP 服务器 —— 为 CANN 开发者提供的 GitCode 平台 MCP 工具集。
+
+## 简介
+
+`cann-gitcode-mcp` 是一个基于 [MCP（Model Context Protocol）](https://modelcontextprotocol.io/) 的服务器，将 GitCode API 操作封装为 MCP 工具，供 Claude Code 及其他 MCP 客户端直接调用。
+
+CANN 社区的代码托管在 GitCode 平台，本项目为 CANN 开发者提供在 AI 助手中操作 GitCode 仓库（Pull Request、流水线、Issue 等）的能力，无需离开对话界面即可完成常见研发工作流。
+
+## 安装
+
+```bash
+pip install cann-gitcode-mcp
+```
+
+## 配置
+
+### 1. 获取 GitCode API Token
+
+在 [GitCode 用户设置](https://gitcode.com/profile/tokens) 中生成个人访问令牌。
+
+### 2. 设置环境变量
+
+```bash
+export GITCODE_API_TOKEN=your_token_here
+```
+
+### 3. 与 Claude Code 集成
+
+在 Claude Code 的 MCP 配置文件中添加：
+
+```json
+{
+  "mcpServers": {
+    "gitcode": {
+      "command": "cann-gitcode-mcp",
+      "env": {
+        "GITCODE_API_TOKEN": "your_token_here"
+      }
+    }
+  }
+}
+```
+
+或使用模块方式：
+
+```json
+{
+  "mcpServers": {
+    "gitcode": {
+      "command": "python",
+      "args": ["-m", "cann_gitcode_mcp"],
+      "env": {
+        "GITCODE_API_TOKEN": "your_token_here"
+      }
+    }
+  }
+}
+```
+
+配置完成后重启 Claude Code，即可在对话中使用所有 GitCode 工具。
+
+## 可用工具
+
+### Pull Request
+
+| 工具名 | 说明 |
+|--------|------|
+| `create_pull_request` | 创建 Pull Request |
+| `list_pull_requests` | 列出仓库的 Pull Request（支持状态、排序等过滤） |
+| `get_pull_request` | 获取指定 PR 的详细信息 |
+| `merge_pull_request` | 合并 Pull Request |
+| `comment_pull_request` | 在 PR 上发表评论 |
+| `get_pull_request_files` | 获取 PR 的变更文件列表 |
+
+## 环境变量
+
+| 变量 | 必填 | 说明 |
+|------|------|------|
+| `GITCODE_API_TOKEN` | 是 | GitCode 个人访问令牌 |
+| `GITCODE_API_BASE_URL` | 否 | API 地址覆盖（默认 `https://gitcode.com/api/v5`） |
+
+## 路线图
+
+- **Issue 工具**：Issue 增删改查、评论管理
+- **仓库工具**：分支管理、文件读取、提交历史
+- **流水线/CI 工具**：触发 CANN CI 流水线、查询流水线状态
+
+## 开发
+
+```bash
+# 安装开发依赖
+pip install -e ".[dev]"
+
+# 运行测试
+pytest
+
+# 构建包
+python -m build
+
+# 上传到 PyPI
+twine upload dist/*
+```
+
+## 版本规则
+
+本项目遵循 [语义化版本](https://semver.org/lang/zh-CN/)：
+
+- `0.x.y` — 早期开发阶段，接口可能不兼容变更
+- `1.0.0` — 工具集稳定后的首个正式版本
+- MAJOR.MINOR.PATCH — 不兼容变更.新功能.修复
+
+## 许可证
+
+[Apache License 2.0](LICENSE)