Skip to content

Commit 642005b

Browse files
committed
refactor: Update terminology from "应用" to "工具" in workflow and documentation
1 parent 61c0440 commit 642005b

4 files changed

Lines changed: 65 additions & 65 deletions

File tree

.github/workflows/build-dev.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "上传应用至OSS dev"
1+
name: "上传工具至OSS dev"
22
on:
33
workflow_dispatch:
44

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "上传应用至OSS stable"
1+
name: "上传工具至OSS stable"
22
on:
33
workflow_dispatch:
44

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# MaxKB Toolstore
22

3-
MaxKB 应用商店 - 强大易用的开源企业级智能体平台应用集合
3+
MaxKB 工具商店 - 强大易用的开源企业级智能体平台工具集合
44

55
## 📖 项目简介
66

7-
MaxKB Toolstore 是 MaxKB 智能体平台的官方应用商店,提供各类工具应用来扩展 MaxKB 的功能。通过这些应用,您可以轻松地为 MaxKB 添加联网搜索、数据库查询等能力。
7+
MaxKB Toolstore 是 MaxKB 智能体平台的官方工具商店,提供各类工具工具来扩展 MaxKB 的功能。通过这些工具,您可以轻松地为 MaxKB 添加联网搜索、数据库查询等能力。
88

9-
## 🚀 现有应用
9+
## 🚀 现有工具
1010

1111
### 联网搜索类
1212
- **秘塔AI搜索** - 强大的AI驱动搜索引擎,提供准确的联网搜索能力
@@ -19,37 +19,37 @@ MaxKB Toolstore 是 MaxKB 智能体平台的官方应用商店,提供各类工
1919
```
2020
MaxKB-toolstore/
2121
├── README.md # 项目说明文档
22-
├── apps/ # 应用目录
23-
│ ├── data.yaml # 应用商店配置
22+
├── apps/ # 工具目录
23+
│ ├── data.yaml # 工具商店配置
2424
│ ├── logo.png # 商店图标
25-
│ ├── metaso/ # 秘塔AI搜索应用
26-
│ │ ├── data.yaml # 应用配置
27-
│ │ ├── logo.png # 应用图标
28-
│ │ ├── README.md # 应用说明
25+
│ ├── metaso/ # 秘塔AI搜索工具
26+
│ │ ├── data.yaml # 工具配置
27+
│ │ ├── logo.png # 工具图标
28+
│ │ ├── README.md # 工具说明
2929
│ │ └── 1.0.0/ # 版本目录
30-
│ └── mongo/ # MongoDB查询应用
31-
│ ├── data.yaml # 应用配置
32-
│ ├── logo.png # 应用图标
33-
│ ├── README.md # 应用说明
30+
│ └── mongo/ # MongoDB查询工具
31+
│ ├── data.yaml # 工具配置
32+
│ ├── logo.png # 工具图标
33+
│ ├── README.md # 工具说明
3434
│ └── 1.0.0/ # 版本目录
3535
```
3636

3737
## 🔧 如何使用
3838

39-
1. 在 MaxKB 平台中访问应用商店
40-
2. 浏览并选择所需的应用
39+
1. 在 MaxKB 平台中访问工具商店
40+
2. 浏览并选择所需的工具
4141
3. 点击安装并按照说明进行配置
4242
4. 开始使用扩展功能
4343

4444
## 🤝 贡献指南
4545

46-
如果您想为 MaxKB Toolstore 贡献新的应用,请参考:
47-
[如何提交自己想要的应用](./如何提交应用.md)
46+
如果您想为 MaxKB Toolstore 贡献新的工具,请参考:
47+
[如何提交自己想要的工具](./如何提交工具.md)
4848

49-
### 应用开发规范
49+
### 工具开发规范
5050

51-
- 每个应用需要包含 `data.yaml` 配置文件
52-
- 提供清晰的应用说明文档
51+
- 每个工具需要包含 `data.yaml` 配置文件
52+
- 提供清晰的工具说明文档
5353
- 包含适当的图标和版本管理
5454
- 遵循 MaxKB 平台的开发规范
5555

如何提交工具.md

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
# 如何提交自己想要的应用
1+
# 如何提交自己想要的工具
22

3-
欢迎为 MaxKB Toolstore 贡献新的应用!本文档将指导您如何为 MaxKB 平台开发和提交应用
3+
欢迎为 MaxKB Toolstore 贡献新的工具!本文档将指导您如何为 MaxKB 平台开发和提交工具
44

55
## 📋 提交前准备
66

7-
### 应用类型要求
7+
### 工具类型要求
88

9-
MaxKB Toolstore 主要接收以下类型的应用
9+
MaxKB Toolstore 主要接收以下类型的工具
1010

11-
- **联网搜索类应用**:为 MaxKB 提供联网搜索能力的工具
12-
- **数据库查询类应用**:支持各种数据库连接和查询的工具
11+
- **联网搜索类工具**:为 MaxKB 提供联网搜索能力的工具
12+
- **数据库查询类工具**:支持各种数据库连接和查询的工具
1313
- **AI 增强工具**:提升 MaxKB 智能体能力的辅助工具
1414
- **数据处理工具**:文档解析、数据转换等功能性工具
1515

16-
### 应用要求
16+
### 工具要求
1717

1818
- 必须是开源项目或提供明确的使用授权
1919
- 有稳定的维护和更新
2020
- 与 MaxKB 平台具有良好的集成性
2121
- 提供完整的使用文档
2222

23-
## 🏗️ 应用结构规范
23+
## 🏗️ 工具结构规范
2424

25-
每个应用需要按照以下目录结构组织
25+
每个工具需要按照以下目录结构组织
2626

2727
```
2828
your-app/
29-
├── data.yaml # 应用配置文件
30-
├── logo.png # 应用图标 (建议 32x32px)
31-
├── README.md # 应用说明文档
29+
├── data.yaml # 工具配置文件
30+
├── logo.png # 工具图标 (建议 32x32px)
31+
├── README.md # 工具说明文档
3232
└── 1.0.0/ # 版本目录
3333
├── main.py # 主程序文件
3434
├── config.yaml # 配置模板
@@ -39,34 +39,34 @@ your-app/
3939

4040
### data.yaml 配置文件
4141

42-
这是应用的核心配置文件,包含应用的基本信息
42+
这是工具的核心配置文件,包含工具的基本信息
4343

4444
```yaml
45-
name: 您的应用名称
45+
name: 您的工具名称
4646
tags:
4747
- 联网搜索 # 或 数据库查询、AI工具等
48-
title: 应用标题
49-
description: 应用详细描述,说明功能和用途
48+
title: 工具标题
49+
description: 工具详细描述,说明功能和用途
5050
```
5151
5252
**字段说明:**
53-
- `name`: 应用的显示名称
54-
- `tags`: 应用分类标签,从预定义标签中选择
55-
- `title`: 应用简短标题
56-
- `description`: 应用功能的详细描述
53+
- `name`: 工具的显示名称
54+
- `tags`: 工具分类标签,从预定义标签中选择
55+
- `title`: 工具简短标题
56+
- `description`: 工具功能的详细描述
5757

5858
### 版本目录结构
5959

6060
每个版本需要独立的目录,包含:
61-
- 应用的主要代码文件
61+
- 工具的主要代码文件
6262
- 配置文件模板
6363
- 版本特定的安装说明
6464

6565
## 🎯 开发指南
6666

67-
### 联网搜索类应用开发
67+
### 联网搜索类工具开发
6868

69-
如果您要开发联网搜索应用,需要:
69+
如果您要开发联网搜索工具,需要:
7070

7171
1. **API 接口**:实现标准的搜索接口
7272
2. **参数配置**:支持搜索参数自定义
@@ -75,7 +75,7 @@ description: 应用详细描述,说明功能和用途
7575

7676
示例参考:`apps/metaso/` 目录
7777

78-
### 数据库查询类应用开发
78+
### 数据库查询类工具开发
7979

8080
数据库连接器需要:
8181

@@ -92,28 +92,28 @@ description: 应用详细描述,说明功能和用途
9292

9393
点击右上角的 "Fork" 按钮,将仓库复制到您的 GitHub 账号下。
9494

95-
### 2. 创建应用目录
95+
### 2. 创建工具目录
9696

97-
在 `apps/` 目录下创建您的应用目录
97+
在 `apps/` 目录下创建您的工具目录
9898

9999
```bash
100100
mkdir apps/your-app-name
101101
cd apps/your-app-name
102102
```
103103

104-
### 3. 编写应用文件
104+
### 3. 编写工具文件
105105

106106
按照上述结构创建必要的文件:
107107
- 编写 `data.yaml` 配置文件
108-
- 添加应用图标 `logo.png`
108+
- 添加工具图标 `logo.png`
109109
- 创建详细的 `README.md`
110-
- 实现应用功能代码
110+
- 实现工具功能代码
111111

112112
### 4. 本地测试
113113

114114
在提交前请确保:
115115
- 配置文件格式正确
116-
- 应用功能正常运行
116+
- 工具功能正常运行
117117
- 文档完整清晰
118118
- 遵循编码规范
119119

@@ -122,22 +122,22 @@ cd apps/your-app-name
122122
1. 提交您的修改:
123123
```bash
124124
git add .
125-
git commit -m "添加 [应用名称] 应用"
125+
git commit -m "添加 [工具名称] 工具"
126126
git push origin main
127127
```
128128

129129
2. 在 GitHub 上创建 Pull Request
130130
3. 在 PR 描述中详细说明:
131-
- 应用的功能和用途
131+
- 工具的功能和用途
132132
- 测试情况
133133
- 相关依赖
134134

135135
## ✅ 审核标准
136136

137-
您的应用将根据以下标准进行审核
137+
您的工具将根据以下标准进行审核
138138

139139
### 功能性审核
140-
- [ ] 应用功能完整可用
140+
- [ ] 工具功能完整可用
141141
- [ ] 与 MaxKB 集成良好
142142
- [ ] 错误处理完善
143143
- [ ] 性能表现良好
@@ -162,9 +162,9 @@ git push origin main
162162

163163
## 🛠️ 开发资源
164164

165-
### 参考应用
166-
- [秘塔AI搜索](apps/metaso/) - 联网搜索类应用参考
167-
- [MongoDB查询工具](apps/mongo/) - 数据库查询类应用参考
165+
### 参考工具
166+
- [秘塔AI搜索](apps/metaso/) - 联网搜索类工具参考
167+
- [MongoDB查询工具](apps/mongo/) - 数据库查询类工具参考
168168

169169
### 开发工具
170170
- MaxKB 开发文档:[官方文档地址]
@@ -178,16 +178,16 @@ git push origin main
178178

179179
## ❓ 常见问题
180180

181-
**Q: 应用审核需要多长时间?**
182-
A: 通常 3-7 个工作日,复杂应用可能需要更长时间
181+
**Q: 工具审核需要多长时间?**
182+
A: 通常 3-7 个工作日,复杂工具可能需要更长时间
183183

184-
**Q: 可以提交商业应用吗?**
184+
**Q: 可以提交商业工具吗?**
185185
A: 可以,但需要明确授权说明和使用条款。
186186

187-
**Q: 如何更新已发布的应用?**
187+
**Q: 如何更新已发布的工具?**
188188
A: 创建新的版本目录,更新配置文件,提交新的 PR。
189189

190-
**Q: 应用有 Bug 怎么办?**
190+
**Q: 工具有 Bug 怎么办?**
191191
A: 及时修复并更新版本,通过 GitHub Issues 跟踪问题。
192192

193193
## 📞 获得帮助
@@ -200,4 +200,4 @@ A: 及时修复并更新版本,通过 GitHub Issues 跟踪问题。
200200

201201
---
202202

203-
感谢您为 MaxKB 生态系统的贡献!我们期待看到您的优秀应用
203+
感谢您为 MaxKB 生态系统的贡献!我们期待看到您的优秀工具

0 commit comments

Comments
 (0)