File size: 5,507 Bytes
7a1ad33 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import * as fs from 'node:fs/promises';
import * as path from 'node:path';
import { glob } from 'glob';
import { load } from 'js-yaml';
import { debugLogger } from '../utils/debugLogger.js';
import { coreEvents } from '../utils/events.js';
/**
* Represents the definition of an Agent Skill.
*/
export interface SkillDefinition {
/** The unique name of the skill. */
name: string;
/** A concise description of what the skill does. */
description: string;
/** The absolute path to the skill's source file on disk. */
location: string;
/** The core logic/instructions of the skill. */
body: string;
/** Whether the skill is currently disabled. */
disabled?: boolean;
/** Whether the skill is a built-in skill. */
isBuiltin?: boolean;
/** The name of the extension that provided this skill, if any. */
extensionName?: string;
}
export const FRONTMATTER_REGEX =
/^---\r?\n([\s\S]*?)\r?\n---(?:\r?\n([\s\S]*))?/;
/**
* Parses frontmatter content using YAML with a fallback to simple key-value parsing.
* This handles cases where description contains colons that would break YAML parsing.
*/
export function parseFrontmatter(
content: string,
): { name: string; description: string } | null {
try {
const parsed = load(content);
if (parsed && typeof parsed === 'object') {
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
const { name, description } = parsed as Record<string, unknown>;
if (typeof name === 'string' && typeof description === 'string') {
return { name, description };
}
}
} catch (yamlError) {
debugLogger.debug(
'YAML frontmatter parsing failed, falling back to simple parser:',
yamlError,
);
}
return parseSimpleFrontmatter(content);
}
/**
* Simple frontmatter parser that extracts name and description fields.
* Handles cases where values contain colons that would break YAML parsing.
*/
function parseSimpleFrontmatter(
content: string,
): { name: string; description: string } | null {
const lines = content.split(/\r?\n/);
let name: string | undefined;
let description: string | undefined;
for (let i = 0; i < lines.length; i++) {
const line = lines[i];
// Match "name:" at the start of the line (optional whitespace)
const nameMatch = line.match(/^\s*name:\s*(.*)$/);
if (nameMatch) {
name = nameMatch[1].trim();
continue;
}
// Match "description:" at the start of the line (optional whitespace)
const descMatch = line.match(/^\s*description:\s*(.*)$/);
if (descMatch) {
const descLines = [descMatch[1].trim()];
// Check for multi-line description (indented continuation lines)
while (i + 1 < lines.length) {
const nextLine = lines[i + 1];
// If next line is indented, it's a continuation of the description
if (nextLine.match(/^[ \t]+\S/)) {
descLines.push(nextLine.trim());
i++;
} else {
break;
}
}
description = descLines.filter(Boolean).join(' ');
continue;
}
}
if (name !== undefined && description !== undefined) {
return { name, description };
}
return null;
}
/**
* Discovers and loads all skills in the provided directory.
*/
export async function loadSkillsFromDir(
dir: string,
): Promise<SkillDefinition[]> {
const discoveredSkills: SkillDefinition[] = [];
try {
const absoluteSearchPath = path.resolve(dir);
const stats = await fs.stat(absoluteSearchPath).catch(() => null);
if (!stats || !stats.isDirectory()) {
return [];
}
const pattern = ['SKILL.md', '*/SKILL.md'];
const skillFiles = await glob(pattern, {
cwd: absoluteSearchPath,
absolute: true,
nodir: true,
ignore: ['**/node_modules/**', '**/.git/**'],
});
for (const skillFile of skillFiles) {
const metadata = await loadSkillFromFile(skillFile);
if (metadata) {
discoveredSkills.push(metadata);
}
}
if (discoveredSkills.length === 0) {
const files = await fs.readdir(absoluteSearchPath);
if (files.length > 0) {
debugLogger.debug(
`Failed to load skills from ${absoluteSearchPath}. The directory is not empty but no valid skills were discovered. Please ensure SKILL.md files are present in subdirectories and have valid frontmatter.`,
);
}
}
} catch (error) {
coreEvents.emitFeedback(
'warning',
`Error discovering skills in ${dir}:`,
error,
);
}
return discoveredSkills;
}
/**
* Loads a single skill from a SKILL.md file.
*/
export async function loadSkillFromFile(
filePath: string,
): Promise<SkillDefinition | null> {
try {
const content = await fs.readFile(filePath, 'utf-8');
const match = content.match(FRONTMATTER_REGEX);
if (!match) {
return null;
}
const frontmatter = parseFrontmatter(match[1]);
if (!frontmatter) {
return null;
}
// Sanitize name for use as a filename/directory name (e.g. replace ':' with '-')
const sanitizedName = frontmatter.name.replace(/[:\\/<>*?"|]/g, '-');
return {
name: sanitizedName,
description: frontmatter.description,
location: filePath,
body: match[2]?.trim() ?? '',
};
} catch (error) {
debugLogger.log(`Error parsing skill file ${filePath}:`, error);
return null;
}
}
|