Skip to content

Commit 6f50d9a

Browse files
54895y54895y
committed
Add MatrixAgentSkills docs
1 parent 359e253 commit 6f50d9a

6 files changed

Lines changed: 305 additions & 1 deletion

File tree

‎docs/matrix-agent-skills/aichat-knowledge-base.mdx‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: AIChat 知识库入口
3+
description: 在 AIChat 中使用 MatrixAgentSkills 的推荐方式。
4+
---
5+
6+
# AIChat 知识库入口
7+
8+
## 推荐入口
9+
10+
AIChat 请优先导入这份知识库文件：
11+
12+
- [https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/aichat/matrixshop-config-kb.md](https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/aichat/matrixshop-config-kb.md)
13+
14+
不要把 Codex skill 当作 AIChat 的首要导入格式。
15+
16+
## 原因
17+
18+
AIChat 更适合：
19+
20+
- 导入结构化知识库
21+
- 直接根据需求生成配置
22+
- 做配置解释和迁移
23+
24+
而不是优先执行一个“过程驱动型 skill”。
25+
26+
## 导入后怎么问
27+
28+
推荐提问方式：
29+
30+
- `根据我的生存服需求生成 MatrixShop 的 module.yml、Economy/currency.yml 和一个 SystemShop 武器商店`
31+
- `给我一套支持点券的 Auction、GlobalMarket 和 PlayerShop 配置`
32+
- `我要一个不使用 shops 目录的 ChestShop、Cart、Record 配置`
33+
- `把这份旧 Malkuth 配置迁移成 MatrixShop 当前格式`
34+
35+
## 当前知识覆盖
36+
37+
当前知识库已经覆盖：
38+
39+
- MatrixShop 当前目录结构
40+
- `shops/*.yml` 与 `settings.yml` 的职责边界
41+
- `Bindings / Help / Help-Key / Hint-Keys / Condition`
42+
- `Economy` 与货币优先级
43+
- `SystemShop` 商品结构
44+
- 当前后台快速上架和快速编辑命令的边界
45+
46+
## 输出建议
47+
48+
如果你要 AIChat 产出可以直接落地的结果，建议要求它：
49+
50+
1. 先给出目标文件路径
51+
2. 再给出完整 YAML
52+
3. 必要时补一小段兼容说明

‎docs/matrix-agent-skills/install-by-agent.mdx‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: 按 Agent 安装
3+
description: MatrixAgentSkills 在不同 agent 中的推荐接入方式。
4+
---
5+
6+
# 按 Agent 安装
7+
8+
## Codex / OpenAI Skills
9+
10+
如果目标 agent 支持 Codex 风格的 GitHub skill 安装，直接发这个路径：
11+
12+
- [https://github.com/54895y/MatrixAgentSkills/tree/main/matrixshop-config](https://github.com/54895y/MatrixAgentSkills/tree/main/matrixshop-config)
13+
14+
推荐表达：
15+
16+
```text
17+
Install the MatrixShop config skill from:
18+
https://github.com/54895y/MatrixAgentSkills/tree/main/matrixshop-config
19+
```
20+
21+
## Claude Code / Gemini CLI / Cline / Roo / Continue
22+
23+
这类 agent 更适合导入一个稳定的 prompt / rules 文件。
24+
25+
通用 raw 入口：
26+
27+
- [https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/portable/matrixshop-config.md](https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/portable/matrixshop-config.md)
28+
29+
仓库中也提供了按 agent 区分的入口文件：
30+
31+
- `claude/matrixshop-config.md`
32+
- `gemini/matrixshop-config.md`
33+
- `cline/matrixshop-config.md`
34+
- `roo/matrixshop-config.md`
35+
- `continue/matrixshop-config.md`
36+
37+
如果 agent 支持远程规则或远程提示文件，优先直接发 raw 链接。
38+
39+
如果不支持远程导入，就把 `portable/matrixshop-config.md` 的内容复制到该 agent 的长期规则或项目规则中。
40+
41+
## AIChat
42+
43+
AIChat 不建议直接导入 Codex skill。
44+
45+
推荐方式是导入知识库：
46+
47+
- [https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/aichat/matrixshop-config-kb.md](https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/aichat/matrixshop-config-kb.md)
48+
49+
导入后直接提配置需求，例如：
50+
51+
- `根据我的生存服需求生成 MatrixShop 的 module.yml、Economy/currency.yml 和一个 SystemShop 分类`
52+
- `帮我生成一个拍卖模块配置，要求使用点券作为默认货币`
53+
- `把下面这份旧 Malkuth 配置迁移成 MatrixShop 当前格式`
54+
55+
## 为什么分三种入口
56+
57+
原因很直接：
58+
59+
- Codex 类 agent 能理解原生 skill 目录
60+
- 其他 agent 更适合单文件规则
61+
- AIChat 更适合知识库，不适合过程型 skill
62+
63+
所以这个仓库同时维护：
64+
65+
- `SKILL.md`
66+
- 通用 prompt
67+
- 知识库文件

‎docs/matrix-agent-skills/matrixshop-config.mdx‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: MatrixShop Config Skill
3+
description: 基于当前 MatrixShop 配置模型的专用 skill 说明。
4+
---
5+
6+
# MatrixShop Config Skill
7+
8+
## Skill 入口
9+
10+
- 原生 skill：[https://github.com/54895y/MatrixAgentSkills/tree/main/matrixshop-config](https://github.com/54895y/MatrixAgentSkills/tree/main/matrixshop-config)
11+
- 通用 prompt：[https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/portable/matrixshop-config.md](https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/portable/matrixshop-config.md)
12+
13+
## 作用
14+
15+
`matrixshop-config` 用来生成、修改、迁移和解释 MatrixShop 的 YAML 配置。
16+
17+
重点不是写一个泛泛的“商城插件配置”，而是约束 agent 必须按 MatrixShop 当前主线结构输出。
18+
19+
## 当前约束
20+
21+
### 使用 `shops/*.yml` 的模块
22+
23+
- `Menu`
24+
- `SystemShop`
25+
- `PlayerShop`
26+
- `GlobalMarket`
27+
- `Auction`
28+
- `Transaction`
29+
30+
### 不使用 `shops/*.yml` 的模块
31+
32+
- `ChestShop`
33+
- `Cart`
34+
- `Record`
35+
36+
### Bindings 规则
37+
38+
对使用 `shops/*.yml` 的模块：
39+
40+
- `Bindings.Commands`
41+
- `Help`
42+
- `Help-Key`
43+
- `Hint-Keys`
44+
- `Condition`
45+
46+
这些键应该写在对应的 shop 文件中。
47+
48+
对不使用 `shops/*.yml` 的模块：
49+
50+
- 这些键应写在 `settings.yml`
51+
52+
### Economy 规则
53+
54+
`Economy` 是核心模块，必须启用。
55+
56+
货币优先级：
57+
58+
1. 商品级
59+
2. 商店级
60+
3. 模块级
61+
4. 默认 `vault`
62+
63+
特殊说明：
64+
65+
- `ChestShop` 只支持模块级货币
66+
- `Cart` 和 `Record` 不定义业务货币
67+
68+
### SystemShop 商品规则
69+
70+
`SystemShop` 商品当前支持：
71+
72+
- `material`
73+
- `item`
74+
- `amount`
75+
- `price`
76+
- `buy-max`
77+
- `name`
78+
- `lore`
79+
- `currency`
80+
81+
## 参考文件
82+
83+
这个 skill 当前拆成三份参考材料：
84+
85+
- `references/config-model.md`
86+
- `references/module-rules.md`
87+
- `references/examples.md`
88+
89+
它们分别负责：
90+
91+
- 总配置结构
92+
- 模块边界
93+
- 可直接照抄的 YAML 示例
94+
95+
## 适合的任务
96+
97+
- 从零生成 MatrixShop 配置
98+
- 生成某个模块的默认配置
99+
- 把旧 Malkuth 配置迁移成 MatrixShop
100+
- 解释某个字段应该放在 `settings.yml` 还是 `shops/*.yml`
101+
- 生成 bindings、help、hint 相关配置

‎docs/matrix-agent-skills/overview.mdx‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: MatrixAgentSkills
3+
description: Matrix 系列插件的公开 skill、prompt pack 与知识库仓库。
4+
---
5+
6+
# MatrixAgentSkills
7+
8+
`MatrixAgentSkills` 是一个公开仓库，用来存放 Matrix 系列插件的技能包、提示包和知识库文件。
9+
10+
仓库地址：
11+
12+
- [https://github.com/54895y/MatrixAgentSkills](https://github.com/54895y/MatrixAgentSkills)
13+
14+
当前首个可用包：
15+
16+
- `matrixshop-config`
17+
18+
## 目标
19+
20+
这个仓库不是只服务一种 agent。
21+
22+
它同时面向三类入口：
23+
24+
1. Codex / OpenAI Skills 这类支持原生 skill 结构的 agent
25+
2. Claude、Gemini、Cline、Roo、Continue 这类更适合吃 prompt / rules 的 agent
26+
3. AIChat 这类更适合导入知识库直接生成配置的产品
27+
28+
## 当前内容
29+
30+
### 原生 skill
31+
32+
- `matrixshop-config`
33+
34+
### 通用 prompt
35+
36+
- `portable/matrixshop-config.md`
37+
38+
### AIChat 知识库
39+
40+
- `aichat/matrixshop-config-kb.md`
41+
42+
## 适用范围
43+
44+
当前 `matrixshop-config` 主要覆盖：
45+
46+
- MatrixShop 目录结构
47+
- `shops/*.yml` 与 `settings.yml` 的职责边界
48+
- `Bindings / Help / Help-Key / Hint-Keys / Condition`
49+
- 经济模块与货币优先级
50+
- `SystemShop / PlayerShop / GlobalMarket / Auction / ChestShop / Transaction / Cart / Record`
51+
- MatrixShop 当前支持的配置字段和输出约束
52+
53+
## 推荐阅读
54+
55+
1. [按 Agent 安装](./install-by-agent)
56+
2. [MatrixShop Config Skill](./matrixshop-config)
57+
3. [AIChat 知识库入口](./aichat-knowledge-base)

‎docs/plugins.mdx‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,21 @@ description: Matrix 系列插件统一文档入口
66

77
# 插件列表
88

9-
这里汇总当前站点已经维护的三款插件文档。所有说明都以当前源码和默认资源文件为准，而不是旧版交接稿或历史目录结构。
9+
这里汇总当前站点已经维护的 Matrix 插件与相关技能文档。所有说明都以当前源码和默认资源文件为准，而不是旧版交接稿或历史目录结构。
10+
11+
## MatrixAgentSkills
12+
13+
MatrixAgentSkills 是 Matrix 系列插件的公开 skill、prompt pack 与知识库仓库，当前已经提供：
14+
15+
- `matrixshop-config`
16+
17+
适用场景：
18+
19+
- Codex 类 agent 原生安装 skill
20+
- Claude / Gemini / Cline / Roo / Continue 导入 prompt
21+
- AIChat 导入知识库后直接生成 MatrixShop 配置
22+
23+
[进入 MatrixAgentSkills 文档](/docs/matrix-agent-skills/overview)
1024

1125
## MatrixAuth
1226

‎sidebars.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@ const sidebars: SidebarsConfig = {
44
docsSidebar: [
55
'plugins',
66
'intro',
7+
{
8+
type: 'category',
9+
label: 'MatrixAgentSkills',
10+
link: {
11+
type: 'doc',
12+
id: 'matrix-agent-skills/overview',
13+
},
14+
items: [
15+
'matrix-agent-skills/install-by-agent',
16+
'matrix-agent-skills/matrixshop-config',
17+
'matrix-agent-skills/aichat-knowledge-base',
18+
],
19+
},
720
{
821
type: 'category',
922
label: 'MatrixAuth',

0 commit comments

Comments
 (0)