A skill is a predefined process for handling high-frequency O&M scenarios. Each skill corresponds to a set of pre-configured analysis steps, tool combinations, and output templates, ensuring consistent analytical approaches when different users invoke the same scenario at different times.
After you describe your requirement in the dialogue, the Agent automatically matches and executes the appropriate skill. You can also actively call a specified skill by entering / in the input box.
Skills and Prerequisites
Skill execution depends on tools, which depend on product connections. Before use, confirm that:
For skills involving clusters, tenants, alerts, or resources, an OCP connection must be configured.
For skills involving slow SQL, TopSQL, ASH, root cause analysis, or statistics, an OAS connection must be configured.
For skills involving database change tickets, an ODC connection must be configured.
For information about how to configure a product connection, see Create a product connection.
Page Overview
Click Skills in the left navigation bar to go to the Skills page. The page displays all skills in the system in card format. Each card contains the skill name, application scenario description, category tags, and enabled status.
Filter and Search
Filter by Category: In the All Categories drop-down list in the upper-left corner, select OceanBase, Basic, Custom, or Community to display only skills of the corresponding category. The OceanBase category includes skills for OceanBase O&M scenarios.
Filter by Status: In the All Statuses drop-down list, select Enabled or Disabled to display only skills of the corresponding status.
Search by Name: Enter a keyword for the skill name in the search box in the upper-right corner to quickly locate it.
Enable and Disable
Click the switch in the upper-right corner of a card to control whether the skill participates in automatic matching:
- After enabling, the card shows Enabled, and the Agent will prioritize matching this skill in related scenarios.
- After disabling, the card shows Disabled, and the Agent will no longer call this skill in related scenarios. It may instead use a general reasoning process to answer, which may reduce the depth of analysis and the standardization of output. It is recommended to disable a skill only if it conflicts with the enterprise's actual O&M processes.
Create a Skill
In addition to built-in skills, you can create custom skills on the Skills page to solidify internal enterprise handling processes into reusable skills. Each custom skill is stored in a SKILL.md file, which follows the standard structure of YAML frontmatter + Markdown body.
SKILL.md File Format
SKILL.md consists of two parts, separated by ---:
- YAML frontmatter: The metadata section at the beginning of the file, containing at least the
nameanddescriptionfields. - Markdown body: All content following the frontmatter, used to describe the detailed usage instructions, procedure, and constraints of the skill.
The following table describes the parameters of the frontmatter field.
field |
Required |
Description |
|---|---|---|
name |
Yes | Skill name, which is used in conversations as/It is displayed during the call. It can contain only lowercase letters, digits, hyphens, and underscores. It must start with a letter or digit and cannot exceed 32 characters in length. Regular expression rule:[a-z0-9][a-z0-9_-]*. |
description |
Yes | The description section supports Markdown syntax and will be rendered accordingly. It is recommended to keep the description within 200 characters. |
Example:
---
name: slow_sql_handbook
description: |
**Purpose**: A quick-handbook for handling slow SQL queries in duty scenarios.
- You can use **Markdown** in the description.
- Lists, links, and code will be properly displayed.
---
## Quick-handbook for handling slow SQL queries
This section describes the skills, procedures, and constraints.
## When to use
* The business reports that an API has become slow, and you need to confirm whether it is caused by a slow SQL query in the database.
* You know the SQL ID and need to view the execution details and optimization directions.
## Procedure
1. Select the target cluster by using `@`.
2. Describe the analysis requirement, for example, "Which SQL queries are the slowest in the last hour?"
3. Wait for the agent to output the list of problematic SQL queries and optimization suggestions.
Procedure
On the Skills page, click Create Skill in the upper-right corner to go to the skill editing page.
In the editing area, write the skill content in the SKILL.md format:
- Write YAML frontmatter at the beginning of the file. Specify at least
nameanddescription. - Write the Markdown body after the
---separator to describe the detailed instructions, procedure, and constraints of the skill.
- Write YAML frontmatter at the beginning of the file. Specify at least
Click Save to complete the creation. A newly created skill is in the Enabled state by default. You can call it immediately in the skill list by using
/skill name. The description area on the skill card renders and displays the content of thedescriptionfield in Markdown format.
Considerations
The
descriptionfield supports Markdown, but it is recommended to keep it concise and avoid using overly long code blocks or nested structures to ensure proper rendering of the card.The tools referenced in the process must be configured and ready through product connection. Otherwise, the skill execution will fail at the corresponding step.
The skill name (
name) must be unique in the system and cannot duplicate existing built-in skills or other custom skills.We recommend that you first verify the actual effect of the new skill on a test cluster before deploying it to production scenarios.
Upload a skill
If your enterprise already has skill definitions accumulated on other platforms, you can package them into a ZIP file containing SKILL.md and upload it for import, eliminating the need to create each one manually.
File format
- Supported formats: Markdown (.md / .markdown / .mdown) or a ZIP package containing SKILL.md.
- For a Markdown file, simply open it in an editor, edit it, and save it.
- The ZIP package must contain the SKILL.md file. The system will automatically recognize and import the skill package.
Procedure
On the Skills page, click Upload Skill in the upper-right corner.
In the pop-up file selection window, drag in or select a skill definition file or a ZIP skill package.
The system performs format validation on the file. If valid, it automatically imports and enables the skill.
A successfully imported skill is initially in the Enabled state, which you can view in the skill list.
Conflict resolution
If the uploaded skill has the same skill ID as an existing skill, the system prompts a conflict. You can choose Overwrite to replace the old version with the new one.
The overwrite operation is irreversible. We recommend that you compare the process differences between the new and old versions before overwriting.
Built-in skills
OAgent comes with built-in skills covering scenarios such as cluster inspection, SQL diagnostics and tuning, alert and exception analysis, ASH diagnostics, statistics diagnostics, and knowledge Q&A. For a complete list, see Built-in skills.