opencode-swarm-plugin 0.12.10 → 0.12.12

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.
@@ -0,0 +1,610 @@
1
+ /**
2
+ * Repo Crawl Module - GitHub API tools for repository research
3
+ *
4
+ * Provides lightweight tools to explore GitHub repositories without cloning.
5
+ * Uses GitHub REST API v3 with optional authentication for higher rate limits.
6
+ *
7
+ * Features:
8
+ * - Parse repo from various formats (owner/repo, URLs)
9
+ * - Support GITHUB_TOKEN env var for auth (optional)
10
+ * - Handle rate limiting gracefully (return error, don't throw)
11
+ * - No external dependencies (uses fetch)
12
+ *
13
+ * Rate Limits:
14
+ * - Unauthenticated: 60 requests/hour
15
+ * - Authenticated: 5000 requests/hour
16
+ *
17
+ * @example
18
+ * ```typescript
19
+ * // Get README
20
+ * repo_readme({ repo: "vercel/next.js" })
21
+ *
22
+ * // Get repo structure
23
+ * repo_structure({ repo: "facebook/react", depth: 2 })
24
+ *
25
+ * // Search code
26
+ * repo_search({ repo: "remix-run/remix", query: "useLoaderData" })
27
+ * ```
28
+ */
29
+ import { tool } from "@opencode-ai/plugin";
30
+ import { z } from "zod";
31
+
32
+ // ============================================================================
33
+ // Configuration
34
+ // ============================================================================
35
+
36
+ const GITHUB_API_URL = "https://api.github.com";
37
+ const GITHUB_TOKEN = process.env.GITHUB_TOKEN;
38
+ const DEFAULT_MAX_RESULTS = 10;
39
+ const DEFAULT_MAX_LENGTH = 10000;
40
+ const DEFAULT_DEPTH = 2;
41
+
42
+ // ============================================================================
43
+ // Types
44
+ // ============================================================================
45
+
46
+ /** GitHub API response for repository */
47
+ interface GitHubRepo {
48
+ name: string;
49
+ full_name: string;
50
+ description: string | null;
51
+ language: string | null;
52
+ stargazers_count: number;
53
+ forks_count: number;
54
+ open_issues_count: number;
55
+ default_branch: string;
56
+ topics: string[];
57
+ }
58
+
59
+ /** GitHub API response for file content */
60
+ interface GitHubContent {
61
+ name: string;
62
+ path: string;
63
+ type: "file" | "dir" | "symlink" | "submodule";
64
+ size: number;
65
+ content?: string;
66
+ encoding?: string;
67
+ download_url?: string;
68
+ }
69
+
70
+ /** GitHub API response for tree */
71
+ interface GitHubTreeItem {
72
+ path: string;
73
+ mode: string;
74
+ type: "blob" | "tree";
75
+ sha: string;
76
+ size?: number;
77
+ }
78
+
79
+ /** GitHub API response for search */
80
+ interface GitHubSearchResult {
81
+ total_count: number;
82
+ items: Array<{
83
+ name: string;
84
+ path: string;
85
+ repository: {
86
+ full_name: string;
87
+ };
88
+ html_url: string;
89
+ text_matches?: Array<{
90
+ fragment: string;
91
+ }>;
92
+ }>;
93
+ }
94
+
95
+ // ============================================================================
96
+ // Errors
97
+ // ============================================================================
98
+
99
+ export class RepoCrawlError extends Error {
100
+ constructor(
101
+ message: string,
102
+ public readonly statusCode?: number,
103
+ public readonly endpoint?: string,
104
+ ) {
105
+ super(message);
106
+ this.name = "RepoCrawlError";
107
+ }
108
+ }
109
+
110
+ // ============================================================================
111
+ // Utilities
112
+ // ============================================================================
113
+
114
+ /**
115
+ * Parse owner/repo from various formats
116
+ *
117
+ * Supports:
118
+ * - "owner/repo"
119
+ * - "github.com/owner/repo"
120
+ * - "https://github.com/owner/repo"
121
+ * - "https://github.com/owner/repo.git"
122
+ *
123
+ * @returns { owner, repo } or throws if invalid
124
+ */
125
+ function parseRepo(input: string): { owner: string; repo: string } {
126
+ // Remove protocol and .git suffix
127
+ let normalized = input
128
+ .replace(/^https?:\/\//, "")
129
+ .replace(/\.git$/, "")
130
+ .replace(/^github\.com\//, "");
131
+
132
+ // Split by slash
133
+ const parts = normalized.split("/").filter(Boolean);
134
+
135
+ if (parts.length < 2) {
136
+ throw new RepoCrawlError(
137
+ `Invalid repo format: "${input}". Expected "owner/repo" or GitHub URL.`,
138
+ );
139
+ }
140
+
141
+ const [owner, repo] = parts;
142
+ return { owner, repo };
143
+ }
144
+
145
+ /**
146
+ * Make a GitHub API request with auth if available
147
+ */
148
+ async function githubFetch<T>(
149
+ endpoint: string,
150
+ options: RequestInit = {},
151
+ ): Promise<T> {
152
+ const headers: Record<string, string> = {
153
+ Accept: "application/vnd.github.v3+json",
154
+ "User-Agent": "opencode-swarm-plugin",
155
+ ...((options.headers as Record<string, string>) || {}),
156
+ };
157
+
158
+ if (GITHUB_TOKEN) {
159
+ headers.Authorization = `Bearer ${GITHUB_TOKEN}`;
160
+ }
161
+
162
+ const url = `${GITHUB_API_URL}${endpoint}`;
163
+ const response = await fetch(url, { ...options, headers });
164
+
165
+ // Handle rate limiting
166
+ if (response.status === 403) {
167
+ const rateLimitRemaining = response.headers.get("x-ratelimit-remaining");
168
+ const rateLimitReset = response.headers.get("x-ratelimit-reset");
169
+
170
+ if (rateLimitRemaining === "0" && rateLimitReset) {
171
+ const resetDate = new Date(parseInt(rateLimitReset) * 1000);
172
+ throw new RepoCrawlError(
173
+ `GitHub API rate limit exceeded. Resets at ${resetDate.toISOString()}. ` +
174
+ `${GITHUB_TOKEN ? "Using authenticated token." : "Set GITHUB_TOKEN env var for higher limits."}`,
175
+ 403,
176
+ endpoint,
177
+ );
178
+ }
179
+ }
180
+
181
+ // Handle not found
182
+ if (response.status === 404) {
183
+ throw new RepoCrawlError(`Resource not found: ${endpoint}`, 404, endpoint);
184
+ }
185
+
186
+ // Handle other errors
187
+ if (!response.ok) {
188
+ const body = await response.text();
189
+ throw new RepoCrawlError(
190
+ `GitHub API error (${response.status}): ${body}`,
191
+ response.status,
192
+ endpoint,
193
+ );
194
+ }
195
+
196
+ return response.json() as Promise<T>;
197
+ }
198
+
199
+ /**
200
+ * Decode base64 content from GitHub API
201
+ */
202
+ function decodeContent(content: string, encoding: string): string {
203
+ if (encoding === "base64") {
204
+ return Buffer.from(content, "base64").toString("utf-8");
205
+ }
206
+ return content;
207
+ }
208
+
209
+ /**
210
+ * Detect tech stack from file extensions and package files
211
+ */
212
+ function detectTechStack(tree: GitHubTreeItem[]): string[] {
213
+ const stack = new Set<string>();
214
+
215
+ const filePatterns: Record<string, string> = {
216
+ "package.json": "Node.js/npm",
217
+ "yarn.lock": "Yarn",
218
+ "pnpm-lock.yaml": "pnpm",
219
+ "bun.lockb": "Bun",
220
+ "Cargo.toml": "Rust",
221
+ "go.mod": "Go",
222
+ "requirements.txt": "Python/pip",
223
+ Pipfile: "Python/pipenv",
224
+ "pyproject.toml": "Python/poetry",
225
+ Gemfile: "Ruby/Bundler",
226
+ "composer.json": "PHP/Composer",
227
+ "pom.xml": "Java/Maven",
228
+ "build.gradle": "Java/Gradle",
229
+ "tsconfig.json": "TypeScript",
230
+ "next.config.js": "Next.js",
231
+ "nuxt.config.js": "Nuxt.js",
232
+ "vue.config.js": "Vue.js",
233
+ "angular.json": "Angular",
234
+ "svelte.config.js": "Svelte",
235
+ Dockerfile: "Docker",
236
+ "docker-compose.yml": "Docker Compose",
237
+ ".terraform": "Terraform",
238
+ Makefile: "Make",
239
+ };
240
+
241
+ for (const item of tree) {
242
+ const basename = item.path.split("/").pop() || "";
243
+
244
+ // Check exact matches
245
+ if (filePatterns[basename]) {
246
+ stack.add(filePatterns[basename]);
247
+ }
248
+
249
+ // Check extensions
250
+ if (basename.endsWith(".rs")) stack.add("Rust");
251
+ if (basename.endsWith(".go")) stack.add("Go");
252
+ if (basename.endsWith(".py")) stack.add("Python");
253
+ if (basename.endsWith(".rb")) stack.add("Ruby");
254
+ if (basename.endsWith(".php")) stack.add("PHP");
255
+ if (basename.endsWith(".java")) stack.add("Java");
256
+ if (basename.endsWith(".kt")) stack.add("Kotlin");
257
+ if (basename.endsWith(".swift")) stack.add("Swift");
258
+ if (basename.endsWith(".ts") || basename.endsWith(".tsx"))
259
+ stack.add("TypeScript");
260
+ if (basename.endsWith(".jsx")) stack.add("React");
261
+ }
262
+
263
+ return Array.from(stack).sort();
264
+ }
265
+
266
+ /**
267
+ * Truncate text to max length with ellipsis
268
+ */
269
+ function truncate(text: string, maxLength: number): string {
270
+ if (text.length <= maxLength) {
271
+ return text;
272
+ }
273
+ return text.slice(0, maxLength) + "\n\n[... truncated ...]";
274
+ }
275
+
276
+ // ============================================================================
277
+ // Tool Definitions
278
+ // ============================================================================
279
+
280
+ /**
281
+ * Get README.md content from a repository
282
+ */
283
+ export const repo_readme = tool({
284
+ description: "Get README.md content from a GitHub repository",
285
+ args: {
286
+ repo: tool.schema
287
+ .string()
288
+ .describe('Repository (e.g., "owner/repo" or GitHub URL)'),
289
+ maxLength: tool.schema
290
+ .number()
291
+ .optional()
292
+ .describe(`Max content length (default: ${DEFAULT_MAX_LENGTH})`),
293
+ },
294
+ async execute(args, ctx) {
295
+ try {
296
+ const { owner, repo } = parseRepo(args.repo);
297
+ const maxLength = args.maxLength || DEFAULT_MAX_LENGTH;
298
+
299
+ // Fetch README
300
+ const readme = await githubFetch<GitHubContent>(
301
+ `/repos/${owner}/${repo}/readme`,
302
+ );
303
+
304
+ if (!readme.content || !readme.encoding) {
305
+ return "README exists but content is not available";
306
+ }
307
+
308
+ const content = decodeContent(readme.content, readme.encoding);
309
+ const truncated = truncate(content, maxLength);
310
+
311
+ return JSON.stringify(
312
+ {
313
+ repo: `${owner}/${repo}`,
314
+ path: readme.path,
315
+ size: readme.size,
316
+ content: truncated,
317
+ truncated: content.length > maxLength,
318
+ },
319
+ null,
320
+ 2,
321
+ );
322
+ } catch (error) {
323
+ if (error instanceof RepoCrawlError) {
324
+ return JSON.stringify({ error: error.message }, null, 2);
325
+ }
326
+ throw error;
327
+ }
328
+ },
329
+ });
330
+
331
+ /**
332
+ * Get repository structure and detect tech stack
333
+ */
334
+ export const repo_structure = tool({
335
+ description:
336
+ "Get repository structure with tech stack detection (root level only by default)",
337
+ args: {
338
+ repo: tool.schema
339
+ .string()
340
+ .describe('Repository (e.g., "owner/repo" or GitHub URL)'),
341
+ depth: tool.schema
342
+ .number()
343
+ .optional()
344
+ .describe(
345
+ `Tree depth (1=root only, 2=one level deep, etc. Default: ${DEFAULT_DEPTH})`,
346
+ ),
347
+ },
348
+ async execute(args, ctx) {
349
+ try {
350
+ const { owner, repo } = parseRepo(args.repo);
351
+ const depth = args.depth || DEFAULT_DEPTH;
352
+
353
+ // Fetch repo metadata
354
+ const repoInfo = await githubFetch<GitHubRepo>(`/repos/${owner}/${repo}`);
355
+
356
+ // Fetch git tree
357
+ const tree = await githubFetch<{
358
+ tree: GitHubTreeItem[];
359
+ truncated: boolean;
360
+ }>(`/repos/${owner}/${repo}/git/trees/${repoInfo.default_branch}`, {
361
+ method: "GET",
362
+ });
363
+
364
+ // Filter by depth
365
+ const filtered = tree.tree.filter((item) => {
366
+ const pathDepth = item.path.split("/").length;
367
+ return pathDepth <= depth;
368
+ });
369
+
370
+ // Detect tech stack
371
+ const techStack = detectTechStack(filtered);
372
+
373
+ // Group by type
374
+ const dirs = filtered
375
+ .filter((item) => item.type === "tree")
376
+ .map((item) => item.path);
377
+ const files = filtered
378
+ .filter((item) => item.type === "blob")
379
+ .map((item) => item.path);
380
+
381
+ return JSON.stringify(
382
+ {
383
+ repo: repoInfo.full_name,
384
+ description: repoInfo.description,
385
+ language: repoInfo.language,
386
+ stars: repoInfo.stargazers_count,
387
+ topics: repoInfo.topics,
388
+ techStack,
389
+ directories: dirs.slice(0, 50), // Limit output
390
+ files: files.slice(0, 50), // Limit output
391
+ truncated: tree.truncated || dirs.length > 50 || files.length > 50,
392
+ },
393
+ null,
394
+ 2,
395
+ );
396
+ } catch (error) {
397
+ if (error instanceof RepoCrawlError) {
398
+ return JSON.stringify({ error: error.message }, null, 2);
399
+ }
400
+ throw error;
401
+ }
402
+ },
403
+ });
404
+
405
+ /**
406
+ * Get directory tree for a specific path
407
+ */
408
+ export const repo_tree = tool({
409
+ description: "Get directory tree for a path in a repository",
410
+ args: {
411
+ repo: tool.schema
412
+ .string()
413
+ .describe('Repository (e.g., "owner/repo" or GitHub URL)'),
414
+ path: tool.schema
415
+ .string()
416
+ .optional()
417
+ .describe("Path in repo (default: root)"),
418
+ maxDepth: tool.schema
419
+ .number()
420
+ .optional()
421
+ .describe(`Max depth to traverse (default: ${DEFAULT_DEPTH})`),
422
+ },
423
+ async execute(args, ctx) {
424
+ try {
425
+ const { owner, repo } = parseRepo(args.repo);
426
+ const targetPath = args.path || "";
427
+ const maxDepth = args.maxDepth || DEFAULT_DEPTH;
428
+
429
+ // Fetch repo info for default branch
430
+ const repoInfo = await githubFetch<GitHubRepo>(`/repos/${owner}/${repo}`);
431
+
432
+ // Fetch contents at path
433
+ const contents = await githubFetch<GitHubContent[]>(
434
+ `/repos/${owner}/${repo}/contents/${targetPath}`,
435
+ );
436
+
437
+ if (!Array.isArray(contents)) {
438
+ return JSON.stringify({ error: "Path is a file, not a directory" });
439
+ }
440
+
441
+ // Build tree structure
442
+ const tree: Array<{ path: string; type: string; size?: number }> = [];
443
+
444
+ for (const item of contents) {
445
+ tree.push({
446
+ path: item.path,
447
+ type: item.type,
448
+ size: item.size,
449
+ });
450
+
451
+ // Recursively fetch subdirectories (up to maxDepth)
452
+ if (item.type === "dir" && maxDepth > 1) {
453
+ try {
454
+ const subContents = await githubFetch<GitHubContent[]>(
455
+ `/repos/${owner}/${repo}/contents/${item.path}`,
456
+ );
457
+ if (Array.isArray(subContents)) {
458
+ for (const subItem of subContents.slice(0, 20)) {
459
+ // Limit per dir
460
+ tree.push({
461
+ path: subItem.path,
462
+ type: subItem.type,
463
+ size: subItem.size,
464
+ });
465
+ }
466
+ }
467
+ } catch {
468
+ // Ignore errors fetching subdirectories
469
+ }
470
+ }
471
+ }
472
+
473
+ return JSON.stringify(
474
+ {
475
+ repo: `${owner}/${repo}`,
476
+ path: targetPath || "(root)",
477
+ items: tree,
478
+ },
479
+ null,
480
+ 2,
481
+ );
482
+ } catch (error) {
483
+ if (error instanceof RepoCrawlError) {
484
+ return JSON.stringify({ error: error.message }, null, 2);
485
+ }
486
+ throw error;
487
+ }
488
+ },
489
+ });
490
+
491
+ /**
492
+ * Get file content from repository
493
+ */
494
+ export const repo_file = tool({
495
+ description: "Get file content from a GitHub repository",
496
+ args: {
497
+ repo: tool.schema
498
+ .string()
499
+ .describe('Repository (e.g., "owner/repo" or GitHub URL)'),
500
+ path: tool.schema.string().describe("File path in repository"),
501
+ maxLength: tool.schema
502
+ .number()
503
+ .optional()
504
+ .describe(`Max content length (default: ${DEFAULT_MAX_LENGTH})`),
505
+ },
506
+ async execute(args, ctx) {
507
+ try {
508
+ const { owner, repo } = parseRepo(args.repo);
509
+ const maxLength = args.maxLength || DEFAULT_MAX_LENGTH;
510
+
511
+ // Fetch file content
512
+ const file = await githubFetch<GitHubContent>(
513
+ `/repos/${owner}/${repo}/contents/${args.path}`,
514
+ );
515
+
516
+ if (file.type !== "file") {
517
+ return JSON.stringify({ error: "Path is not a file" });
518
+ }
519
+
520
+ if (!file.content || !file.encoding) {
521
+ return JSON.stringify({ error: "File content not available" });
522
+ }
523
+
524
+ const content = decodeContent(file.content, file.encoding);
525
+ const truncated = truncate(content, maxLength);
526
+
527
+ return JSON.stringify(
528
+ {
529
+ repo: `${owner}/${repo}`,
530
+ path: file.path,
531
+ size: file.size,
532
+ content: truncated,
533
+ truncated: content.length > maxLength,
534
+ },
535
+ null,
536
+ 2,
537
+ );
538
+ } catch (error) {
539
+ if (error instanceof RepoCrawlError) {
540
+ return JSON.stringify({ error: error.message }, null, 2);
541
+ }
542
+ throw error;
543
+ }
544
+ },
545
+ });
546
+
547
+ /**
548
+ * Search code in a repository
549
+ */
550
+ export const repo_search = tool({
551
+ description: "Search code in a GitHub repository",
552
+ args: {
553
+ repo: tool.schema
554
+ .string()
555
+ .describe('Repository (e.g., "owner/repo" or GitHub URL)'),
556
+ query: tool.schema.string().describe("Search query (GitHub code search)"),
557
+ maxResults: tool.schema
558
+ .number()
559
+ .optional()
560
+ .describe(`Max results (default: ${DEFAULT_MAX_RESULTS})`),
561
+ },
562
+ async execute(args, ctx) {
563
+ try {
564
+ const { owner, repo } = parseRepo(args.repo);
565
+ const maxResults = args.maxResults || DEFAULT_MAX_RESULTS;
566
+
567
+ // GitHub search API requires "repo:" qualifier
568
+ const searchQuery = `${args.query} repo:${owner}/${repo}`;
569
+
570
+ // Search code
571
+ const results = await githubFetch<GitHubSearchResult>(
572
+ `/search/code?q=${encodeURIComponent(searchQuery)}&per_page=${maxResults}`,
573
+ );
574
+
575
+ const items = results.items.map((item) => ({
576
+ path: item.path,
577
+ url: item.html_url,
578
+ matches: item.text_matches?.map((m) => m.fragment) || [],
579
+ }));
580
+
581
+ return JSON.stringify(
582
+ {
583
+ repo: `${owner}/${repo}`,
584
+ query: args.query,
585
+ totalCount: results.total_count,
586
+ results: items,
587
+ },
588
+ null,
589
+ 2,
590
+ );
591
+ } catch (error) {
592
+ if (error instanceof RepoCrawlError) {
593
+ return JSON.stringify({ error: error.message }, null, 2);
594
+ }
595
+ throw error;
596
+ }
597
+ },
598
+ });
599
+
600
+ // ============================================================================
601
+ // Export all tools
602
+ // ============================================================================
603
+
604
+ export const repoCrawlTools = {
605
+ repo_readme,
606
+ repo_structure,
607
+ repo_tree,
608
+ repo_file,
609
+ repo_search,
610
+ };
@@ -131,3 +131,24 @@ export const ValidationResultSchema = z.object({
131
131
  extractionMethod: z.string().optional(),
132
132
  });
133
133
  export type ValidationResult = z.infer<typeof ValidationResultSchema>;
134
+
135
+ /**
136
+ * Failure mode taxonomy for task failures
137
+ *
138
+ * Classifies WHY tasks fail, not just that they failed.
139
+ * Used in outcome tracking to learn from failure patterns.
140
+ *
141
+ * @see src/learning.ts OutcomeSignalsSchema
142
+ * @see "Patterns for Building AI Agents" p.46
143
+ */
144
+ export const FailureModeSchema = z.enum([
145
+ "timeout", // Task exceeded time limit
146
+ "conflict", // File reservation conflict
147
+ "validation", // Output failed schema validation
148
+ "tool_failure", // Tool call returned error
149
+ "context_overflow", // Ran out of context window
150
+ "dependency_blocked", // Waiting on another subtask
151
+ "user_cancelled", // User interrupted
152
+ "unknown", // Unclassified
153
+ ]);
154
+ export type FailureMode = z.infer<typeof FailureModeSchema>;