zugzbot 1.0.0 → 1.0.1

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.
Files changed (41) hide show
  1. package/README.md +99 -23
  2. package/bin/init.js +1 -2
  3. package/package.json +2 -3
  4. package/.utils/docs_opencode/acp.md +0 -165
  5. package/.utils/docs_opencode/acp.pdf +0 -0
  6. package/.utils/docs_opencode/agents.md +0 -803
  7. package/.utils/docs_opencode/agents.pdf +0 -0
  8. package/.utils/docs_opencode/commands.md +0 -354
  9. package/.utils/docs_opencode/commands.pdf +0 -0
  10. package/.utils/docs_opencode/custom-tools.md +0 -209
  11. package/.utils/docs_opencode/custom-tools.pdf +0 -0
  12. package/.utils/docs_opencode/ecosystem.md +0 -81
  13. package/.utils/docs_opencode/ecosystem.pdf +0 -0
  14. package/.utils/docs_opencode/formatters.md +0 -142
  15. package/.utils/docs_opencode/formatters.pdf +0 -0
  16. package/.utils/docs_opencode/keybinds.md +0 -205
  17. package/.utils/docs_opencode/keybinds.pdf +0 -0
  18. package/.utils/docs_opencode/lsp.md +0 -202
  19. package/.utils/docs_opencode/lsp.pdf +0 -0
  20. package/.utils/docs_opencode/mcp-servers.md +0 -565
  21. package/.utils/docs_opencode/mcp-servers.pdf +0 -0
  22. package/.utils/docs_opencode/models.md +0 -234
  23. package/.utils/docs_opencode/models.pdf +0 -0
  24. package/.utils/docs_opencode/permissions.md +0 -248
  25. package/.utils/docs_opencode/permissions.pdf +0 -0
  26. package/.utils/docs_opencode/plugins.md +0 -409
  27. package/.utils/docs_opencode/plugins.pdf +0 -0
  28. package/.utils/docs_opencode/rules.md +0 -189
  29. package/.utils/docs_opencode/rules.pdf +0 -0
  30. package/.utils/docs_opencode/sdk.md +0 -522
  31. package/.utils/docs_opencode/sdk.pdf +0 -0
  32. package/.utils/docs_opencode/server.md +0 -324
  33. package/.utils/docs_opencode/server.pdf +0 -0
  34. package/.utils/docs_opencode/skills.md +0 -235
  35. package/.utils/docs_opencode/skills.pdf +0 -0
  36. package/.utils/docs_opencode/themes.md +0 -378
  37. package/.utils/docs_opencode/themes.pdf +0 -0
  38. package/.utils/docs_opencode/tools.md +0 -364
  39. package/.utils/docs_opencode/tools.pdf +0 -0
  40. package/.utils/export_opencode_session.py +0 -242
  41. package/.utils/toggle_model.py +0 -208
@@ -1,565 +0,0 @@
1
- # MCP servidores
2
-
3
- Agregue herramientas MCP locales y remotas.
4
-
5
- Puede agregar herramientas externas a OpenCode utilizando el *Model Context Protocol* o MCP. OpenCode admite servidores locales y remotos.
6
-
7
- Una vez agregadas, las herramientas MCP están disponibles automáticamente para LLM junto con las herramientas integradas.
8
-
9
- ---
10
-
11
- #### [Advertencias](#advertencias)
12
-
13
- Cuando utiliza un servidor MCP, se suma al contexto. Esto puede acumularse rápidamente si tiene muchas herramientas. Por lo que recomendamos tener cuidado con qué servidores MCP utiliza.
14
-
15
- > [!TIP]
16
- > Los servidores MCP se agregan a su contexto, por lo que debe tener cuidado con cuáles habilita.
17
-
18
- Ciertos servidores MCP, como el servidor GitHub MCP, tienden a agregar muchos tokens y pueden exceder fácilmente el límite de contexto.
19
-
20
- ---
21
-
22
- ## [Habilitar](#habilitar)
23
-
24
- Puede definir servidores MCP en su [OpenCode Config](https://opencode.ai/docs/config/) en `mcp`. Agregue cada MCP con un nombre único. Puede referirse a ese MCP por su nombre cuando solicite el LLM.
25
-
26
- **File**: opencode.jsonc
27
-
28
- ```jsonc
29
- {
30
- "$schema": "https://opencode.ai/config.json",
31
- "mcp": {
32
- "name-of-mcp-server": {
33
- // ...
34
- "enabled": true,
35
- },
36
- "name-of-other-mcp-server": {
37
- // ...
38
- },
39
- },
40
- }
41
- ```
42
-
43
- También puede desactivar un servidor configurando `enabled` en `false`. Esto es útil si desea desactivar temporalmente un servidor sin eliminarlo de su configuración.
44
-
45
- ---
46
-
47
- ### [Anulación de los valores predeterminados remotos](#anulación-de-los-valores-predeterminados-remotos)
48
-
49
- Las organizaciones pueden proporcionar servidores MCP predeterminados a través de su punto final `.well-known/opencode`. Estos servidores pueden estar deshabilitados de forma predeterminada, lo que permite a los usuarios optar por los que necesitan.
50
-
51
- Para habilitar un servidor específico desde la configuración remota de su organización, agréguelo a su configuración local con `enabled: true`:
52
-
53
- **File**: opencode.json
54
-
55
- ```json
56
- {
57
- "$schema": "https://opencode.ai/config.json",
58
- "mcp": {
59
- "jira": {
60
- "type": "remote",
61
- "url": "https://jira.example.com/mcp",
62
- "enabled": true
63
- }
64
- }
65
- }
66
- ```
67
-
68
- Los valores de configuración local anulan los valores predeterminados remotos. Consulte [precedencia de configuración](https://opencode.ai/docs/config#precedence-order) para obtener más detalles.
69
-
70
- ---
71
-
72
- ## [Locales](#locales)
73
-
74
- Agregue servidores MCP locales usando `type` a `"local"` dentro del objeto MCP.
75
-
76
- **File**: opencode.jsonc
77
-
78
- ```jsonc
79
- {
80
- "$schema": "https://opencode.ai/config.json",
81
- "mcp": {
82
- "my-local-mcp-server": {
83
- "type": "local",
84
- // Or ["bun", "x", "my-mcp-command"]
85
- "command": ["npx", "-y", "my-mcp-command"],
86
- "enabled": true,
87
- "environment": {
88
- "MY_ENV_VAR": "my_env_var_value",
89
- },
90
- },
91
- },
92
- }
93
- ```
94
-
95
- El comando es cómo se inicia el servidor MCP local. También puede pasar una lista de variables de entorno.
96
-
97
- Por ejemplo, así es como puede agregar el servidor de prueba ``[@modelcontextprotocol/server-everything](https://www.npmjs.com/package/@modelcontextprotocol/server-everything) MCP.
98
-
99
- **File**: opencode.jsonc
100
-
101
- ```jsonc
102
- {
103
- "$schema": "https://opencode.ai/config.json",
104
- "mcp": {
105
- "mcp_everything": {
106
- "type": "local",
107
- "command": ["npx", "-y", "@modelcontextprotocol/server-everything"],
108
- },
109
- },
110
- }
111
- ```
112
-
113
- Y para usarlo puedo agregar `use the mcp_everything tool` a mis indicaciones.
114
-
115
- **File**:
116
-
117
- ```txt
118
- use the mcp_everything tool to add the number 3 and 4
119
- ```
120
-
121
- ---
122
-
123
- #### [Opciones](#opciones)
124
-
125
- Aquí están todas las opciones para configurar un servidor MCP local.
126
- ````````````
127
-
128
- | Opción Tipo Requerido Descripción |
129
- | --- |
130
- | type Cadena Y El tipo de conexión del servidor MCP debe ser "local" . |
131
- | command Matriz Y Comando y argumentos para ejecutar el servidor MCP. |
132
- | environment Objeto Variables de entorno para configurar al ejecutar el servidor. |
133
- | enabled booleano Habilite o deshabilite el servidor MCP al inicio. |
134
- | timeout Número Tiempo de espera en ms para recuperar herramientas del servidor MCP. El valor predeterminado es 5000 (5 segundos). |
135
-
136
-
137
- ---
138
-
139
- ## [Remoto](#remoto)
140
-
141
- Agregue servidores MCP remotos configurando `type` en `"remote"`.
142
-
143
- **File**: opencode.json
144
-
145
- ```json
146
- {
147
- "$schema": "https://opencode.ai/config.json",
148
- "mcp": {
149
- "my-remote-mcp": {
150
- "type": "remote",
151
- "url": "https://my-mcp-server.com",
152
- "enabled": true,
153
- "headers": {
154
- "Authorization": "Bearer MY_API_KEY"
155
- }
156
- }
157
- }
158
- }
159
- ```
160
-
161
- `url` es la URL del servidor MCP remoto y con la opción `headers` puede pasar una lista de encabezados.
162
-
163
- ---
164
-
165
- #### [Opciones](#opciones-1)
166
- ````````````[OAuth](#oauth)``
167
-
168
- | Opción Tipo Requerido Descripción |
169
- | --- |
170
- | type Cadena Y El tipo de conexión del servidor MCP debe ser "remote" . |
171
- | url Cadena Y URL del servidor MCP remoto. |
172
- | enabled booleano Habilite o deshabilite el servidor MCP al inicio. |
173
- | headers Objeto Encabezados para enviar con la solicitud. |
174
- | oauth Objeto OAuth configuración de autenticación. Consulte la sección a continuación. |
175
- | timeout Número Tiempo de espera en ms para recuperar herramientas del servidor MCP. El valor predeterminado es 5000 (5 segundos). |
176
-
177
-
178
- ---
179
-
180
- ## [OAuth](#oauth)
181
-
182
- OpenCode maneja automáticamente la autenticación OAuth para servidores MCP remotos. Cuando un servidor requiere autenticación, OpenCode:
183
-
184
- 1. Detectar la respuesta 401 e iniciar el flujo OAuth
185
- 1. Utilice **Registro dinámico de cliente (RFC 7591)** si el servidor lo admite.
186
- 1. Almacene tokens de forma segura para futuras solicitudes
187
-
188
- ---
189
-
190
- ### [Automático](#automático)
191
-
192
- Para la mayoría de los servidores MCP habilitados para OAuth, no se necesita ninguna configuración especial. Simplemente configure el servidor remoto:
193
-
194
- **File**: opencode.json
195
-
196
- ```json
197
- {
198
- "$schema": "https://opencode.ai/config.json",
199
- "mcp": {
200
- "my-oauth-server": {
201
- "type": "remote",
202
- "url": "https://mcp.example.com/mcp"
203
- }
204
- }
205
- }
206
- ```
207
-
208
- Si el servidor requiere autenticación, OpenCode le pedirá que se autentique cuando intente usarlo por primera vez. De lo contrario, puede [activar manualmente el flujo](#authenticating) con `opencode mcp auth `.
209
-
210
- ---
211
-
212
- ### [Preinscrito](#preinscrito)
213
-
214
- Si tiene credenciales de cliente del proveedor del servidor MCP, puede configurarlas:
215
-
216
- **File**: opencode.json
217
-
218
- ```json
219
- {
220
- "$schema": "https://opencode.ai/config.json",
221
- "mcp": {
222
- "my-oauth-server": {
223
- "type": "remote",
224
- "url": "https://mcp.example.com/mcp",
225
- "oauth": {
226
- "clientId": "{env:MY_MCP_CLIENT_ID}",
227
- "clientSecret": "{env:MY_MCP_CLIENT_SECRET}",
228
- "scope": "tools:read tools:execute"
229
- }
230
- }
231
- }
232
- }
233
- ```
234
-
235
- ---
236
-
237
- ### [Autenticación](#autenticación)
238
-
239
- Puede activar manualmente la autenticación o administrar las credenciales.
240
-
241
- Autenticar con un servidor MCP específico:
242
-
243
- **File**: Ventana de terminal
244
-
245
- ```bash
246
- opencode mcp auth my-oauth-server
247
- ```
248
-
249
- Enumere todos los servidores MCP y su estado de autenticación:
250
-
251
- **File**: Ventana de terminal
252
-
253
- ```bash
254
- opencode mcp list
255
- ```
256
-
257
- Eliminar las credenciales almacenadas:
258
-
259
- **File**: Ventana de terminal
260
-
261
- ```bash
262
- opencode mcp logout my-oauth-server
263
- ```
264
-
265
- El comando `mcp auth` abrirá su navegador para obtener autorización. Después de su autorización, OpenCode almacenará los tokens de forma segura en `~/.local/share/opencode/mcp-auth.json`.
266
-
267
- ---
268
-
269
- #### [Deshabilitando OAuth](#deshabilitando-oauth)
270
-
271
- Si desea deshabilitar el OAuth automático para un servidor (por ejemplo, para servidores que usan claves API), configure `oauth` en `false`:
272
-
273
- **File**: opencode.json
274
-
275
- ```json
276
- {
277
- "$schema": "https://opencode.ai/config.json",
278
- "mcp": {
279
- "my-api-key-server": {
280
- "type": "remote",
281
- "url": "https://mcp.example.com/mcp",
282
- "oauth": false,
283
- "headers": {
284
- "Authorization": "Bearer {env:MY_API_KEY}"
285
- }
286
- }
287
- }
288
- }
289
- ```
290
-
291
- ---
292
-
293
- #### [Opciones de OAuth](#opciones-de-oauth)
294
- ``````````
295
-
296
- | Opción Tipo Descripción |
297
- | --- |
298
- | oauth Objeto \| falso OAuth objeto de configuración, o false para deshabilitar la detección automática de OAuth. |
299
- | clientId Cadena OAuth ID de cliente. Si no se proporciona, se intentará el registro dinámico del cliente. |
300
- | clientSecret Cadena OAuth secreto del cliente, si lo requiere el servidor de autorización. |
301
- | scope Cadena OAuth alcances para solicitar durante la autorización. |
302
-
303
-
304
- #### [Depuración](#depuración)
305
-
306
- Si un servidor MCP remoto no puede autenticarse, puede diagnosticar problemas con:
307
-
308
- **File**: Ventana de terminal
309
-
310
- ```bash
311
- # View auth status for all OAuth-capable servers
312
- opencode mcp auth list
313
-
314
- # Debug connection and OAuth flow for a specific server
315
- opencode mcp debug my-oauth-server
316
- ```
317
-
318
- El comando `mcp debug` muestra el estado de autenticación actual, prueba la conectividad HTTP e intenta el flujo de descubrimiento OAuth.
319
-
320
- ---
321
-
322
- ## [Administrar](#administrar)
323
-
324
- Sus MCP están disponibles como herramientas en OpenCode, junto con herramientas integradas. Para que puedas administrarlos a través de la configuración OpenCode como cualquier otra herramienta.
325
-
326
- ---
327
-
328
- ### [Global](#global)
329
-
330
- Esto significa que puede habilitarlos o deshabilitarlos globalmente.
331
-
332
- **File**: opencode.json
333
-
334
- ```json
335
- {
336
- "$schema": "https://opencode.ai/config.json",
337
- "mcp": {
338
- "my-mcp-foo": {
339
- "type": "local",
340
- "command": ["bun", "x", "my-mcp-command-foo"]
341
- },
342
- "my-mcp-bar": {
343
- "type": "local",
344
- "command": ["bun", "x", "my-mcp-command-bar"]
345
- }
346
- },
347
- "tools": {
348
- "my-mcp-foo": false
349
- }
350
- }
351
- ```
352
-
353
- También podemos usar un patrón global para deshabilitar todos los MCP coincidentes.
354
-
355
- **File**: opencode.json
356
-
357
- ```json
358
- {
359
- "$schema": "https://opencode.ai/config.json",
360
- "mcp": {
361
- "my-mcp-foo": {
362
- "type": "local",
363
- "command": ["bun", "x", "my-mcp-command-foo"]
364
- },
365
- "my-mcp-bar": {
366
- "type": "local",
367
- "command": ["bun", "x", "my-mcp-command-bar"]
368
- }
369
- },
370
- "tools": {
371
- "my-mcp*": false
372
- }
373
- }
374
- ```
375
-
376
- Aquí estamos usando el patrón global `my-mcp*` para deshabilitar todos los MCP.
377
-
378
- ---
379
-
380
- ### [Por agente](#por-agente)
381
-
382
- Si tiene una gran cantidad de servidores MCP, es posible que desee habilitarlos solo por agente y deshabilitarlos globalmente. Para hacer esto:
383
-
384
- 1. Desactívelo como herramienta a nivel global.
385
- 1. En su [configuración del agente](https://opencode.ai/docs/agents#tools), habilite el servidor MCP como herramienta.
386
-
387
- **File**: opencode.json
388
-
389
- ```json
390
- {
391
- "$schema": "https://opencode.ai/config.json",
392
- "mcp": {
393
- "my-mcp": {
394
- "type": "local",
395
- "command": ["bun", "x", "my-mcp-command"],
396
- "enabled": true
397
- }
398
- },
399
- "tools": {
400
- "my-mcp*": false
401
- },
402
- "agent": {
403
- "my-agent": {
404
- "tools": {
405
- "my-mcp*": true
406
- }
407
- }
408
- }
409
- }
410
- ```
411
-
412
- ---
413
-
414
- #### [Patrones globales](#patrones-globales)
415
-
416
- El patrón global utiliza patrones globales simples de expresiones regulares:
417
-
418
- - `*` coincide con cero o más de cualquier carácter (por ejemplo, `"my-mcp*"` coincide con `my-mcp_search`, `my-mcp_list`, etc.)
419
- - `?` coincide exactamente con un carácter
420
- - Todos los demás caracteres coinciden literalmente
421
-
422
- > [!NOTE]
423
- > Las herramientas del servidor MCP están registradas con el nombre del servidor como prefijo, por lo que para deshabilitar todas las herramientas para un servidor simplemente use:
424
- > **File**:
425
- > ```plaintext
426
- > "mymcpservername_*": false
427
- > ```
428
-
429
- ---
430
-
431
- ## [Ejemplos](#ejemplos)
432
-
433
- A continuación se muestran ejemplos de algunos servidores MCP comunes. Puede enviar un PR si desea documentar otros servidores.
434
-
435
- ---
436
-
437
- ### [sentry](#sentry)
438
-
439
- Agregue el [servidor Sentry MCP](https://mcp.sentry.dev) para interactuar con sus proyectos y problemas Sentry.
440
-
441
- **File**: opencode.json
442
-
443
- ```json
444
- {
445
- "$schema": "https://opencode.ai/config.json",
446
- "mcp": {
447
- "sentry": {
448
- "type": "remote",
449
- "url": "https://mcp.sentry.dev/mcp",
450
- "oauth": {}
451
- }
452
- }
453
- }
454
- ```
455
-
456
- Después de agregar la configuración, autentíquese con Sentry:
457
-
458
- **File**: Ventana de terminal
459
-
460
- ```bash
461
- opencode mcp auth sentry
462
- ```
463
-
464
- Esto abrirá una ventana del navegador para completar el flujo OAuth y conectar OpenCode a su cuenta Sentry.
465
-
466
- Una vez autenticado, puede utilizar las herramientas Sentry en sus indicaciones para consultar problemas, proyectos y datos de errores.
467
-
468
- **File**:
469
-
470
- ```txt
471
- Show me the latest unresolved issues in my project. use sentry
472
- ```
473
-
474
- ---
475
-
476
- ### [Context7](#context7)
477
-
478
- Agregue el [servidor Context7 MCP](https://github.com/upstash/context7) para buscar en los documentos.
479
-
480
- **File**: opencode.json
481
-
482
- ```json
483
- {
484
- "$schema": "https://opencode.ai/config.json",
485
- "mcp": {
486
- "context7": {
487
- "type": "remote",
488
- "url": "https://mcp.context7.com/mcp"
489
- }
490
- }
491
- }
492
- ```
493
-
494
- Si se ha registrado para obtener una cuenta gratuita, puede usar su clave API y obtener límites de tarifas más altos.
495
-
496
- **File**: opencode.json
497
-
498
- ```json
499
- {
500
- "$schema": "https://opencode.ai/config.json",
501
- "mcp": {
502
- "context7": {
503
- "type": "remote",
504
- "url": "https://mcp.context7.com/mcp",
505
- "headers": {
506
- "CONTEXT7_API_KEY": "{env:CONTEXT7_API_KEY}"
507
- }
508
- }
509
- }
510
- }
511
- ```
512
-
513
- Aquí asumimos que tiene configurada la variable de entorno `CONTEXT7_API_KEY`.
514
-
515
- Agregue `use context7` a sus indicaciones para usar el servidor Context7 MCP.
516
-
517
- **File**:
518
-
519
- ```txt
520
- Configure a Cloudflare Worker script to cache JSON API responses for five minutes. use context7
521
- ```
522
-
523
- Alternativamente, puede agregar algo como esto a su [AGENTS.md](https://opencode.ai/docs/rules/).
524
-
525
- **File**: AGENTS.md
526
-
527
- ```md
528
- When you need to search docs, use `context7` tools.
529
- ```
530
-
531
- ---
532
-
533
- ### [Grep by Vercel](#grep-by-vercel)
534
-
535
- Agregue el servidor [Grep by Vercel](https://grep.app) MCP para buscar fragmentos de código en GitHub.
536
-
537
- **File**: opencode.json
538
-
539
- ```json
540
- {
541
- "$schema": "https://opencode.ai/config.json",
542
- "mcp": {
543
- "gh_grep": {
544
- "type": "remote",
545
- "url": "https://mcp.grep.app"
546
- }
547
- }
548
- }
549
- ```
550
-
551
- Dado que llamamos a nuestro servidor MCP `gh_grep`, puede agregar `use the gh_grep tool` a sus indicaciones para que el agente lo use.
552
-
553
- **File**:
554
-
555
- ```txt
556
- What's the right way to set a custom domain in an SST Astro component? use the gh_grep tool
557
- ```
558
-
559
- Alternativamente, puede agregar algo como esto a su [AGENTS.md](https://opencode.ai/docs/rules/).
560
-
561
- **File**: AGENTS.md
562
-
563
- ```md
564
- If you are unsure how to do something, use `gh_grep` to search code examples from GitHub.
565
- ```