Skip to content

Commit c8170db

Browse files
shiyuhang0shiyuhang0
authored
Add Agent skill (#331)
1 parent 1d783a8 commit c8170db

33 files changed

Lines changed: 2755 additions & 3 deletions

‎.cursor/skills/create-ticloud-cli-command/LICENSE.txt‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎.cursor/skills/create-ticloud-cli-command/SKILL.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
name: create-ticloud-cli-command
3+
description: Builds TiDB Cloud CLI commands. Use when creating new commands.
4+
license: Complete terms in LICENSE.txt
5+
metadata:
6+
author: shiyuhang0
7+
---
8+
9+
# Create TiCloud CLI Command
10+
11+
This skill builds TiDB Cloud CLI commands, helping users create new commands with production-ready code.
12+
13+
## When to use
14+
15+
- The user asks to create new CLI commands or subcommands.
16+
- Do not use when the agent does not support plan mode.
17+
18+
## About TiDB Cloud CLI
19+
20+
TiDB Cloud CLI (TiCloud CLI) is a command-line interface for interacting with TiDB Cloud, built on the Cobra library.
21+
22+
Key design of TiDB Cloud CLI:
23+
- Built on the Cobra library.
24+
- Uses the TiDB Cloud Open API as the client and keeps the SDK inside the project.
25+
- Every command supports both interactive and non-interactive modes.
26+
27+
- More about TiDB Cloud CLI: `references/tidbcloud-cli.md`.
28+
- More about Cobra: `references/cobra.md`.
29+
30+
## Core Principles
31+
32+
### Plan first
33+
34+
The AI agent must switch to plan mode to collect information from the user and generate a plan first.
35+
36+
Then use agent mode to generate the code.
37+
38+
### Test first
39+
40+
If the user requires testing, testing takes precedence over implementation. Write tests first, then implement, and finally validate against the tests.
41+
42+
### Declarative
43+
44+
The user must declare the command format; the implementation must comply with that declared format.
45+
46+
## Workflow
47+
48+
Must follow the workflow below:
49+
50+
### Generate SDK phase
51+
52+
Always prompt the user: "Do you need to add or update swagger? Please provide the swagger path if you need."
53+
54+
Skip this phase if user does not need.
55+
56+
Once in this phase, follow the guide in `references/sdk.md` to generate the SDK.
57+
58+
After SDK is generated, ask user to use go>=1.24 to run `make generate-mocks` manually!
59+
60+
### Plan phase
61+
62+
The agent must switch to plan mode in this phase.
63+
64+
The agent must ask the user for the following information during the plan phase:
65+
1. **Command format**: If the user does not provide the command format, ask them to provide it first. See `assets/command.md` for the command format template. The commnad flags can be omitted as it can be inferred from swagger.
66+
2. **Tests**: Ask whether the user needs tests. Tests are recommended.
67+
3. **Other necessary information**
68+
69+
Generate the plan after the user confirms all the information.
70+
71+
### Agent phase
72+
73+
The agent must switch to agent mode in this phase. Follow the workflow below:
74+
75+
1. **Ensure the generate SDK phase**
76+
2. **Write unit tests**
77+
3. **Implement command**
78+
4. **Run tests**
79+
80+
#### Ensure the sdk
81+
82+
Ensure generate SDK phase has been done.
83+
84+
#### Write unit tests
85+
86+
Skip this step if the user does not need tests.
87+
88+
Write unit tests following `references/ut.md`. If the tests need to invoke the command, create the empty command first. See `assets/empty.go`.
89+
90+
#### Implement command
91+
92+
Implement the command following the patterns in `assets/example`.
93+
94+
The implementation must meet the following requirements:
95+
96+
1. **Command definition**: Include name, aliases, example, and other necessary attributes.
97+
98+
2. **Flags definition**: Include flag type, description, default value, etc. Infer flag information from the Swagger spec and SDK client parameters. See `references/flag.md` for more details. Please get customer confirmation once the flags are set.
99+
100+
3. **Flags retrieval**: Implement retrieval logic for both interactive and non-interactive modes. For interactive mode, UI is required. The UI is based on the Bubbletea library. See `references/ui.md` for more details.
101+
102+
4. **Dual mode support**: Support both interactive and non-interactive modes. Rules:
103+
1. **Detect mode** with `MarkInteractive`:
104+
- Default to interactive.
105+
- If any non-interactive flag is provided, switch to non-interactive and mark required flags.
106+
2. **Interactive constraints**:
107+
- If `!h.IOStreams.CanPrompt`, return an error instructing the user to use non-interactive flags.
108+
109+
5. **SDK calls**: Use the SDK client in `api_client.go` to call the corresponding method. Note that `assets/example` does not include this part (it is only a template); it must be included when implementing the actual command.
110+
111+
#### Run the tests
112+
113+
Skip this step if the user does not need tests.
114+
115+
Run tests with: `go test -race -cover -count=1 path -v`
116+
117+
For example, to run tests under `internal/cli/serverless/branch`: `go test -race -cover -count=1 ./internal/cli/serverless/branch -v`.
118+
119+
Ensure all tests pass. If they do not pass, fix the implementation or the tests.
120+
121+
## Final Code Structure
122+
123+
The final code structure must follow the structure in `assets/example`:
124+
125+
- Command Go files.
126+
- UI Go files.
127+
- Test files if needed.
128+
129+
Command output should follow the patterns in `assets/example`:
130+
131+
- **Human output**: Print a concise, user-friendly message; use `color.GreenString` for success. Avoid raw JSON in human mode.
132+
- **JSON output**: Use `output.PrintJson` with a stable, predictable payload (e.g. keys like `message`, resource IDs, `items`).
133+
- **No TTY**: Default to JSON output for list/describe-style commands (see `assets/example/list.go`).
134+
- **Examples**: Include `Example` blocks for both interactive and non-interactive usage (see `assets/example/create.go` and `assets/example/list.go`).

‎.cursor/skills/create-ticloud-cli-command/assets/command.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Command format
2+
3+
This document describes the command format users need to provide. The following uses the example resource:
4+
5+
6+
```
7+
ticloud serverless example create -c --displayname
8+
ticloud serverless example get -c --example-id
9+
ticloud serverless example list -c --output
10+
ticloud serverless example delete -c --example-id --force
11+
```
12+
13+
Flags can be omitted and inferred from the TiDB Cloud SDK. The following are also accepted:
14+
15+
```
16+
ticloud serverless example create
17+
ticloud serverless example get
18+
ticloud serverless example list
19+
ticloud serverless example delete
20+
```

‎.cursor/skills/create-ticloud-cli-command/assets/empty.go‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Copyright 2026 PingCAP, Inc.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package example
16+
17+
import (
18+
"github.com/spf13/cobra"
19+
20+
"github.com/tidbcloud/tidbcloud-cli/internal"
21+
)
22+
23+
func CreateCmd(h *internal.Helper) *cobra.Command {
24+
return nil
25+
}

0 commit comments

Comments
 (0)