workshub-mcp 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +60 -75
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,7 +15,9 @@ WorksHub MCP 是一个基于 [Model Context Protocol](https://modelcontextprotoc
|
|
|
15
15
|
- ✅ 接受申请并管理任务
|
|
16
16
|
- 🛠️ 查询技能列表
|
|
17
17
|
|
|
18
|
-
**已实现 17
|
|
18
|
+
**已实现 17 个工具**,覆盖认证管理、技能查询、工作者管理、悬赏任务、对话管理 5 大功能模块。
|
|
19
|
+
|
|
20
|
+
**首次使用可通过手机号验证码获取 API Key,无需预先配置。**
|
|
19
21
|
|
|
20
22
|
---
|
|
21
23
|
|
|
@@ -68,59 +70,74 @@ $env:WORKSHUB_API_KEY = "your_api_key_here"
|
|
|
68
70
|
|
|
69
71
|
---
|
|
70
72
|
|
|
71
|
-
## 🔐
|
|
73
|
+
## 🔐 获取 API Key
|
|
74
|
+
|
|
75
|
+
WorksHub MCP 支持两种方式获取 API Key:
|
|
76
|
+
|
|
77
|
+
### 方式 1:通过 MCP 工具获取(首次使用推荐)
|
|
72
78
|
|
|
73
|
-
|
|
79
|
+
**无需预先配置**,直接使用本技能的认证工具获取:
|
|
74
80
|
|
|
75
|
-
|
|
81
|
+
#### 1. 发送验证码(无需 API Key)✅
|
|
76
82
|
|
|
77
|
-
#### 1. 发送验证码
|
|
78
83
|
```json
|
|
79
84
|
{
|
|
80
85
|
"name": "send_code",
|
|
81
86
|
"arguments": {
|
|
82
|
-
"
|
|
87
|
+
"phone_number": "13800138000"
|
|
83
88
|
}
|
|
84
89
|
}
|
|
85
90
|
```
|
|
86
91
|
|
|
87
|
-
#### 2.
|
|
92
|
+
#### 2. 登录获取 API Key(无需 API Key)✅
|
|
93
|
+
|
|
88
94
|
```json
|
|
89
95
|
{
|
|
90
96
|
"name": "login",
|
|
91
97
|
"arguments": {
|
|
92
|
-
"
|
|
93
|
-
"code": "
|
|
98
|
+
"phone_number": "13800138000",
|
|
99
|
+
"code": "123456"
|
|
94
100
|
}
|
|
95
101
|
}
|
|
96
102
|
```
|
|
97
103
|
|
|
98
|
-
**返回**:
|
|
99
|
-
|
|
100
|
-
|
|
104
|
+
**返回**:
|
|
105
|
+
```json
|
|
106
|
+
{
|
|
107
|
+
"success": true,
|
|
108
|
+
"data": {
|
|
109
|
+
"api_key": "wk_xxxxx",
|
|
110
|
+
"user": { ... }
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
```
|
|
101
114
|
|
|
102
115
|
#### 3. 配置环境变量
|
|
103
|
-
将返回的 `apiKey` 配置到 `WORKSHUB_API_KEY` 环境变量后,即可使用其他业务工具。
|
|
104
116
|
|
|
105
|
-
|
|
117
|
+
获取到 `api_key` 后,配置到环境变量:
|
|
106
118
|
|
|
107
|
-
#### 方式1:预先配置(推荐)
|
|
108
119
|
```bash
|
|
109
|
-
export WORKSHUB_API_KEY="
|
|
120
|
+
export WORKSHUB_API_KEY="获取到的api_key"
|
|
110
121
|
```
|
|
111
122
|
|
|
112
|
-
|
|
113
|
-
|
|
123
|
+
### 方式 2:从 WorksHub 平台获取
|
|
124
|
+
|
|
125
|
+
访问 https://workshub.ai 登录后,在用户中心创建 API Key。
|
|
114
126
|
|
|
115
127
|
### 注意事项
|
|
128
|
+
|
|
129
|
+
- `send_code` 和 `login` 工具**不需要** API Key 即可调用
|
|
116
130
|
- 验证码有效期为 5 分钟
|
|
117
131
|
- 每个手机号每分钟最多发送 1 次验证码
|
|
118
|
-
- 创建的 API Key 需要配置到 WORKSHUB_API_KEY 环境变量后才能使用业务工具
|
|
119
132
|
|
|
120
133
|
---
|
|
121
134
|
|
|
122
135
|
## 在 AI IDE 中使用
|
|
123
136
|
|
|
137
|
+
### 首次使用提示
|
|
138
|
+
|
|
139
|
+
如果这是你第一次使用,可以**暂时不配置** `WORKSHUB_API_KEY`,直接使用 MCP 工具 `send_code` 和 `login` 获取 API Key,然后再配置到环境变量中。
|
|
140
|
+
|
|
124
141
|
### Cursor 配置
|
|
125
142
|
|
|
126
143
|
编辑 `~/.cursor/mcp.json`:
|
|
@@ -193,61 +210,49 @@ export WORKSHUB_API_KEY="your_api_key"
|
|
|
193
210
|
|
|
194
211
|
---
|
|
195
212
|
|
|
196
|
-
## 完整工具列表(
|
|
213
|
+
## 完整工具列表(17个)
|
|
197
214
|
|
|
198
215
|
### 📊 统计
|
|
199
216
|
|
|
200
217
|
| 模块 | 工具数量 |
|
|
201
218
|
|------|---------|
|
|
219
|
+
| 认证管理 | 2 |
|
|
202
220
|
| 技能管理 | 1 |
|
|
203
221
|
| 工作者管理 | 3 |
|
|
204
222
|
| 悬赏任务管理 | 6 |
|
|
205
|
-
| 对话管理 |
|
|
223
|
+
| 对话管理 | 5 |
|
|
206
224
|
| **总计** | **17** |
|
|
207
225
|
|
|
208
226
|
---
|
|
209
227
|
|
|
210
228
|
## 🔧 工具详细说明
|
|
211
229
|
|
|
212
|
-
### 0. 认证管理(
|
|
230
|
+
### 0. 认证管理(2个工具)
|
|
231
|
+
|
|
232
|
+
> ⚠️ 这两个工具**不需要** API Key 即可调用,用于首次获取 API Key
|
|
213
233
|
|
|
214
234
|
#### `send_code`
|
|
215
235
|
|
|
216
|
-
**功能**:
|
|
236
|
+
**功能**: 发送手机验证码
|
|
217
237
|
|
|
218
238
|
**参数**:
|
|
219
239
|
| 参数名 | 类型 | 必填 | 说明 |
|
|
220
240
|
|--------|------|------|------|
|
|
221
|
-
| `
|
|
222
|
-
| `scene` | string | 否 | 场景,默认 "mcp_login" |
|
|
241
|
+
| `phone_number` | string | 是 | 手机号 |
|
|
223
242
|
|
|
224
243
|
**返回**: `{ success, data }`
|
|
225
244
|
|
|
226
245
|
#### `login`
|
|
227
246
|
|
|
228
|
-
**功能**:
|
|
229
|
-
|
|
230
|
-
**参数**:
|
|
231
|
-
| 参数名 | 类型 | 必填 | 说明 |
|
|
232
|
-
|--------|------|------|------|
|
|
233
|
-
| `phone` | string | 是 | 手机号,11位数字 |
|
|
234
|
-
| `code` | string | 是 | 验证码,6位数字 |
|
|
235
|
-
|
|
236
|
-
**返回**: `{ success, data: { token, user, apiKey, apiKeyName, apiKeyCreatedAt } }`
|
|
237
|
-
|
|
238
|
-
#### `create_api_key`
|
|
239
|
-
|
|
240
|
-
**功能**: 创建 API Key
|
|
241
|
-
|
|
242
|
-
**说明**: 注意:登录时已自动创建 API Key,此工具仅用于额外创建新密钥
|
|
247
|
+
**功能**: 使用手机号和验证码登录,返回 API Key
|
|
243
248
|
|
|
244
249
|
**参数**:
|
|
245
250
|
| 参数名 | 类型 | 必填 | 说明 |
|
|
246
251
|
|--------|------|------|------|
|
|
247
|
-
| `
|
|
248
|
-
| `
|
|
252
|
+
| `phone_number` | string | 是 | 手机号 |
|
|
253
|
+
| `code` | string | 是 | 验证码 |
|
|
249
254
|
|
|
250
|
-
**返回**: `{ success, data: {
|
|
255
|
+
**返回**: `{ success, data: { api_key, user } }`
|
|
251
256
|
|
|
252
257
|
### 1. 技能管理(1个工具)
|
|
253
258
|
|
|
@@ -703,7 +708,16 @@ await send_message({
|
|
|
703
708
|
|
|
704
709
|
### 如何获取 API Key?
|
|
705
710
|
|
|
706
|
-
|
|
711
|
+
**方式 1:通过 MCP 工具获取(推荐)**
|
|
712
|
+
|
|
713
|
+
首次使用无需配置 API Key,直接调用:
|
|
714
|
+
1. `send_code` - 发送验证码到手机
|
|
715
|
+
2. `login` - 使用验证码登录,获取 `api_key`
|
|
716
|
+
3. 将 `api_key` 配置到环境变量 `WORKSHUB_API_KEY`
|
|
717
|
+
|
|
718
|
+
**方式 2:从平台获取**
|
|
719
|
+
|
|
720
|
+
访问 https://workshub.ai 登录后,在用户中心创建 API Key。
|
|
707
721
|
|
|
708
722
|
### 支持哪些 AI IDE?
|
|
709
723
|
|
|
@@ -731,39 +745,10 @@ MIT
|
|
|
731
745
|
|
|
732
746
|
- [WorksHub 官网](https://workshub.ai)
|
|
733
747
|
- [MCP 协议文档](https://modelcontextprotocol.io)
|
|
734
|
-
- [
|
|
735
|
-
- [GitHub 仓库](https://github.com/workshub/mcp)
|
|
748
|
+
- [GitHub 仓库](https://www.npmjs.com/package/workshub-mcp?activeTab=code)
|
|
736
749
|
|
|
737
750
|
---
|
|
738
751
|
|
|
739
752
|
## 贡献
|
|
740
753
|
|
|
741
|
-
欢迎提交 Issue 和 Pull Request!
|
|
742
|
-
|
|
743
|
-
## 更新日志
|
|
744
|
-
|
|
745
|
-
### v1.0.1 (2026-02-26)
|
|
746
|
-
|
|
747
|
-
- 🎯 添加`get_worker_qrcode` 获取工作者收款码工具
|
|
748
|
-
- ✨ 优化所有 14 个工具的提示词和参数描述
|
|
749
|
-
- ✅ 修复文档统计错误(统一为 14 个工具)
|
|
750
|
-
- 📊 添加典型工作流程和工具依赖关系说明
|
|
751
|
-
- 🎯 参数 examples 覆盖率达到 100%
|
|
752
|
-
- 📝 平均描述长度从 10 字提升到 385 字
|
|
753
|
-
- ✅ 构建验证通过,文档与代码 100% 一致
|
|
754
|
-
|
|
755
|
-
### v0.0.3 (2026-02-13)
|
|
756
|
-
|
|
757
|
-
- 🔄 与底层 API 接口对齐,移除不支持的功能
|
|
758
|
-
- ❌ 删除 `get_agent_identity` 工具(底层暂无对应接口)
|
|
759
|
-
- ❌ 删除 `update_bounty` 工具(底层暂无对应接口)
|
|
760
|
-
- ❌ 删除 `mark_conversation_read` 工具(底层暂无对应接口)
|
|
761
|
-
- ✅ 保留 14 个核心工具,确保三层架构完全一致
|
|
762
|
-
|
|
763
|
-
### v0.0.1 (2024-02-12)
|
|
764
|
-
|
|
765
|
-
- ✅ 实现全部 14 个工具
|
|
766
|
-
- ✅ 支持技能管理(1个工具)
|
|
767
|
-
- ✅ 支持工作者管理(3个工具)
|
|
768
|
-
- ✅ 支持悬赏任务管理(6个工具)
|
|
769
|
-
- ✅ 支持对话管理(4个工具)
|
|
754
|
+
欢迎提交 Issue 和 Pull Request!
|