yuque-mcp-plus 0.2.1 → 0.2.2
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/CHANGELOG.md +6 -0
- package/README.en.md +99 -0
- package/README.md +99 -0
- package/package.json +1 -1
- package/src/server.js +1 -1
package/CHANGELOG.md
CHANGED
package/README.en.md
CHANGED
|
@@ -96,6 +96,10 @@ Release workflow:
|
|
|
96
96
|
|
|
97
97
|
## Codex MCP Config Example
|
|
98
98
|
|
|
99
|
+
If you want to switch between the local source tree and the published npm package, only `command + args` need to change.
|
|
100
|
+
|
|
101
|
+
Source mode:
|
|
102
|
+
|
|
99
103
|
```toml
|
|
100
104
|
[mcp_servers.yuque]
|
|
101
105
|
command = "node"
|
|
@@ -105,6 +109,17 @@ args = [ "/Users/program/code/code_mcp/yuque-mcp-plus/src/index.js" ]
|
|
|
105
109
|
YUQUE_TOKEN = "your-token"
|
|
106
110
|
```
|
|
107
111
|
|
|
112
|
+
npm mode:
|
|
113
|
+
|
|
114
|
+
```toml
|
|
115
|
+
[mcp_servers.yuque]
|
|
116
|
+
command = "npx"
|
|
117
|
+
args = [ "-y", "yuque-mcp-plus" ]
|
|
118
|
+
|
|
119
|
+
[mcp_servers.yuque.env]
|
|
120
|
+
YUQUE_TOKEN = "your-token"
|
|
121
|
+
```
|
|
122
|
+
|
|
108
123
|
## Other Client Integrations
|
|
109
124
|
|
|
110
125
|
The examples below are based on the client docs available on 2026-03-04. UI labels and config file locations may change, but the local `stdio` startup model is the same.
|
|
@@ -113,14 +128,23 @@ The examples below are based on the client docs available on 2026-03-04. UI labe
|
|
|
113
128
|
|
|
114
129
|
The current official docs recommend registering a local `stdio` MCP server with a command like this:
|
|
115
130
|
|
|
131
|
+
Source mode:
|
|
132
|
+
|
|
116
133
|
```bash
|
|
117
134
|
claude mcp add --transport stdio yuque -- node /Users/program/code/code_mcp/yuque-mcp-plus/src/index.js
|
|
118
135
|
```
|
|
119
136
|
|
|
137
|
+
npm mode:
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
claude mcp add --transport stdio yuque -- npx -y yuque-mcp-plus
|
|
141
|
+
```
|
|
142
|
+
|
|
120
143
|
With environment variables:
|
|
121
144
|
|
|
122
145
|
```bash
|
|
123
146
|
claude mcp add --transport stdio --env YUQUE_TOKEN=your-token yuque -- node /Users/program/code/code_mcp/yuque-mcp-plus/src/index.js
|
|
147
|
+
claude mcp add --transport stdio --env YUQUE_TOKEN=your-token yuque -- npx -y yuque-mcp-plus
|
|
124
148
|
```
|
|
125
149
|
|
|
126
150
|
Useful management commands:
|
|
@@ -132,6 +156,8 @@ claude mcp get yuque
|
|
|
132
156
|
|
|
133
157
|
If you prefer project-shared config, you can also place this in your project root `.mcp.json`:
|
|
134
158
|
|
|
159
|
+
Source mode:
|
|
160
|
+
|
|
135
161
|
```json
|
|
136
162
|
{
|
|
137
163
|
"mcpServers": {
|
|
@@ -148,6 +174,25 @@ If you prefer project-shared config, you can also place this in your project roo
|
|
|
148
174
|
}
|
|
149
175
|
```
|
|
150
176
|
|
|
177
|
+
npm mode:
|
|
178
|
+
|
|
179
|
+
```json
|
|
180
|
+
{
|
|
181
|
+
"mcpServers": {
|
|
182
|
+
"yuque": {
|
|
183
|
+
"command": "npx",
|
|
184
|
+
"args": [
|
|
185
|
+
"-y",
|
|
186
|
+
"yuque-mcp-plus"
|
|
187
|
+
],
|
|
188
|
+
"env": {
|
|
189
|
+
"YUQUE_TOKEN": "${YUQUE_TOKEN}"
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
```
|
|
195
|
+
|
|
151
196
|
### Qoder
|
|
152
197
|
|
|
153
198
|
Qoder currently supports adding MCP servers directly from the settings UI.
|
|
@@ -161,6 +206,8 @@ Path:
|
|
|
161
206
|
|
|
162
207
|
Use this project with:
|
|
163
208
|
|
|
209
|
+
Source mode:
|
|
210
|
+
|
|
164
211
|
```json
|
|
165
212
|
{
|
|
166
213
|
"mcpServers": {
|
|
@@ -177,6 +224,25 @@ Use this project with:
|
|
|
177
224
|
}
|
|
178
225
|
```
|
|
179
226
|
|
|
227
|
+
npm mode:
|
|
228
|
+
|
|
229
|
+
```json
|
|
230
|
+
{
|
|
231
|
+
"mcpServers": {
|
|
232
|
+
"yuque": {
|
|
233
|
+
"command": "npx",
|
|
234
|
+
"args": [
|
|
235
|
+
"-y",
|
|
236
|
+
"yuque-mcp-plus"
|
|
237
|
+
],
|
|
238
|
+
"env": {
|
|
239
|
+
"YUQUE_TOKEN": "your-token"
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
```
|
|
245
|
+
|
|
180
246
|
After saving, a successful connection icon should appear. Use Qoder in `Agent mode` so it can invoke MCP tools.
|
|
181
247
|
|
|
182
248
|
### OpenCode
|
|
@@ -185,6 +251,8 @@ OpenCode currently configures MCP in `opencode.jsonc`. Local MCP servers belong
|
|
|
185
251
|
|
|
186
252
|
Example:
|
|
187
253
|
|
|
254
|
+
Source mode:
|
|
255
|
+
|
|
188
256
|
```jsonc
|
|
189
257
|
{
|
|
190
258
|
"$schema": "https://opencode.ai/config.json",
|
|
@@ -204,6 +272,28 @@ Example:
|
|
|
204
272
|
}
|
|
205
273
|
```
|
|
206
274
|
|
|
275
|
+
npm mode:
|
|
276
|
+
|
|
277
|
+
```jsonc
|
|
278
|
+
{
|
|
279
|
+
"$schema": "https://opencode.ai/config.json",
|
|
280
|
+
"mcp": {
|
|
281
|
+
"yuque": {
|
|
282
|
+
"type": "local",
|
|
283
|
+
"command": [
|
|
284
|
+
"npx",
|
|
285
|
+
"-y",
|
|
286
|
+
"yuque-mcp-plus"
|
|
287
|
+
],
|
|
288
|
+
"enabled": true,
|
|
289
|
+
"environment": {
|
|
290
|
+
"YUQUE_TOKEN": "your-token"
|
|
291
|
+
}
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
}
|
|
295
|
+
```
|
|
296
|
+
|
|
207
297
|
In prompts, you can refer to it explicitly, for example:
|
|
208
298
|
|
|
209
299
|
```text
|
|
@@ -223,11 +313,20 @@ Typical flow:
|
|
|
223
313
|
|
|
224
314
|
Recommended values:
|
|
225
315
|
|
|
316
|
+
Source mode:
|
|
317
|
+
|
|
226
318
|
- Name: `yuque`
|
|
227
319
|
- Command: `node`
|
|
228
320
|
- Args: `/Users/program/code/code_mcp/yuque-mcp-plus/src/index.js`
|
|
229
321
|
- Env: `YUQUE_TOKEN=your-token`
|
|
230
322
|
|
|
323
|
+
npm mode:
|
|
324
|
+
|
|
325
|
+
- Name: `yuque`
|
|
326
|
+
- Command: `npx`
|
|
327
|
+
- Args: `-y yuque-mcp-plus`
|
|
328
|
+
- Env: `YUQUE_TOKEN=your-token`
|
|
329
|
+
|
|
231
330
|
Notes:
|
|
232
331
|
|
|
233
332
|
- The exact entry point and field names may vary by Trae version
|
package/README.md
CHANGED
|
@@ -107,6 +107,10 @@ npm test
|
|
|
107
107
|
|
|
108
108
|
## Codex MCP 配置示例
|
|
109
109
|
|
|
110
|
+
如果你想在本地源码和 npm 已发布包之间切换,可以直接替换 `command + args`。
|
|
111
|
+
|
|
112
|
+
源码模式:
|
|
113
|
+
|
|
110
114
|
```toml
|
|
111
115
|
[mcp_servers.yuque]
|
|
112
116
|
command = "node"
|
|
@@ -116,6 +120,17 @@ args = [ "/Users/program/code/code_mcp/yuque-mcp-plus/src/index.js" ]
|
|
|
116
120
|
YUQUE_TOKEN = "your-token"
|
|
117
121
|
```
|
|
118
122
|
|
|
123
|
+
npm 模式:
|
|
124
|
+
|
|
125
|
+
```toml
|
|
126
|
+
[mcp_servers.yuque]
|
|
127
|
+
command = "npx"
|
|
128
|
+
args = [ "-y", "yuque-mcp-plus" ]
|
|
129
|
+
|
|
130
|
+
[mcp_servers.yuque.env]
|
|
131
|
+
YUQUE_TOKEN = "your-token"
|
|
132
|
+
```
|
|
133
|
+
|
|
119
134
|
## 其他客户端接入
|
|
120
135
|
|
|
121
136
|
下面这些示例基于 2026-03-04 当天可查到的客户端文档整理。不同版本的 UI 或配置文件位置可能会变,但本地 `stdio` 启动方式基本一致。
|
|
@@ -124,14 +139,23 @@ YUQUE_TOKEN = "your-token"
|
|
|
124
139
|
|
|
125
140
|
官方文档当前推荐直接用命令注册本地 `stdio` MCP:
|
|
126
141
|
|
|
142
|
+
源码模式:
|
|
143
|
+
|
|
127
144
|
```bash
|
|
128
145
|
claude mcp add --transport stdio yuque -- node /Users/program/code/code_mcp/yuque-mcp-plus/src/index.js
|
|
129
146
|
```
|
|
130
147
|
|
|
148
|
+
npm 模式:
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
claude mcp add --transport stdio yuque -- npx -y yuque-mcp-plus
|
|
152
|
+
```
|
|
153
|
+
|
|
131
154
|
如果要带环境变量:
|
|
132
155
|
|
|
133
156
|
```bash
|
|
134
157
|
claude mcp add --transport stdio --env YUQUE_TOKEN=your-token yuque -- node /Users/program/code/code_mcp/yuque-mcp-plus/src/index.js
|
|
158
|
+
claude mcp add --transport stdio --env YUQUE_TOKEN=your-token yuque -- npx -y yuque-mcp-plus
|
|
135
159
|
```
|
|
136
160
|
|
|
137
161
|
常用管理命令:
|
|
@@ -143,6 +167,8 @@ claude mcp get yuque
|
|
|
143
167
|
|
|
144
168
|
如果你使用项目共享配置,也可以把它写进项目根目录的 `.mcp.json`:
|
|
145
169
|
|
|
170
|
+
源码模式:
|
|
171
|
+
|
|
146
172
|
```json
|
|
147
173
|
{
|
|
148
174
|
"mcpServers": {
|
|
@@ -159,6 +185,25 @@ claude mcp get yuque
|
|
|
159
185
|
}
|
|
160
186
|
```
|
|
161
187
|
|
|
188
|
+
npm 模式:
|
|
189
|
+
|
|
190
|
+
```json
|
|
191
|
+
{
|
|
192
|
+
"mcpServers": {
|
|
193
|
+
"yuque": {
|
|
194
|
+
"command": "npx",
|
|
195
|
+
"args": [
|
|
196
|
+
"-y",
|
|
197
|
+
"yuque-mcp-plus"
|
|
198
|
+
],
|
|
199
|
+
"env": {
|
|
200
|
+
"YUQUE_TOKEN": "${YUQUE_TOKEN}"
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
```
|
|
206
|
+
|
|
162
207
|
### Qoder
|
|
163
208
|
|
|
164
209
|
Qoder 当前支持在设置页里直接添加 MCP。
|
|
@@ -172,6 +217,8 @@ Qoder 当前支持在设置页里直接添加 MCP。
|
|
|
172
217
|
|
|
173
218
|
本项目可直接使用:
|
|
174
219
|
|
|
220
|
+
源码模式:
|
|
221
|
+
|
|
175
222
|
```json
|
|
176
223
|
{
|
|
177
224
|
"mcpServers": {
|
|
@@ -188,6 +235,25 @@ Qoder 当前支持在设置页里直接添加 MCP。
|
|
|
188
235
|
}
|
|
189
236
|
```
|
|
190
237
|
|
|
238
|
+
npm 模式:
|
|
239
|
+
|
|
240
|
+
```json
|
|
241
|
+
{
|
|
242
|
+
"mcpServers": {
|
|
243
|
+
"yuque": {
|
|
244
|
+
"command": "npx",
|
|
245
|
+
"args": [
|
|
246
|
+
"-y",
|
|
247
|
+
"yuque-mcp-plus"
|
|
248
|
+
],
|
|
249
|
+
"env": {
|
|
250
|
+
"YUQUE_TOKEN": "your-token"
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
```
|
|
256
|
+
|
|
191
257
|
保存后如果能看到连接图标,说明服务已成功连上。使用时要切到 `Agent mode`,这样 Qoder 才会调用 MCP 工具。
|
|
192
258
|
|
|
193
259
|
### OpenCode
|
|
@@ -196,6 +262,8 @@ OpenCode 当前在 `opencode.jsonc` 里配置 MCP。本地 MCP 要放在 `mcp`
|
|
|
196
262
|
|
|
197
263
|
示例:
|
|
198
264
|
|
|
265
|
+
源码模式:
|
|
266
|
+
|
|
199
267
|
```jsonc
|
|
200
268
|
{
|
|
201
269
|
"$schema": "https://opencode.ai/config.json",
|
|
@@ -215,6 +283,28 @@ OpenCode 当前在 `opencode.jsonc` 里配置 MCP。本地 MCP 要放在 `mcp`
|
|
|
215
283
|
}
|
|
216
284
|
```
|
|
217
285
|
|
|
286
|
+
npm 模式:
|
|
287
|
+
|
|
288
|
+
```jsonc
|
|
289
|
+
{
|
|
290
|
+
"$schema": "https://opencode.ai/config.json",
|
|
291
|
+
"mcp": {
|
|
292
|
+
"yuque": {
|
|
293
|
+
"type": "local",
|
|
294
|
+
"command": [
|
|
295
|
+
"npx",
|
|
296
|
+
"-y",
|
|
297
|
+
"yuque-mcp-plus"
|
|
298
|
+
],
|
|
299
|
+
"enabled": true,
|
|
300
|
+
"environment": {
|
|
301
|
+
"YUQUE_TOKEN": "your-token"
|
|
302
|
+
}
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
}
|
|
306
|
+
```
|
|
307
|
+
|
|
218
308
|
使用时可以在提示词里直接点名,例如:
|
|
219
309
|
|
|
220
310
|
```text
|
|
@@ -234,11 +324,20 @@ Trae 已经支持 MCP,但我当前没查到和 Qoder/OpenCode 一样完整公
|
|
|
234
324
|
|
|
235
325
|
建议填写:
|
|
236
326
|
|
|
327
|
+
源码模式:
|
|
328
|
+
|
|
237
329
|
- Name: `yuque`
|
|
238
330
|
- Command: `node`
|
|
239
331
|
- Args: `/Users/program/code/code_mcp/yuque-mcp-plus/src/index.js`
|
|
240
332
|
- Env: `YUQUE_TOKEN=your-token`
|
|
241
333
|
|
|
334
|
+
npm 模式:
|
|
335
|
+
|
|
336
|
+
- Name: `yuque`
|
|
337
|
+
- Command: `npx`
|
|
338
|
+
- Args: `-y yuque-mcp-plus`
|
|
339
|
+
- Env: `YUQUE_TOKEN=your-token`
|
|
340
|
+
|
|
242
341
|
说明:
|
|
243
342
|
|
|
244
343
|
- Trae 的具体入口位置和字段名可能会随版本变化
|
package/package.json
CHANGED