File size: 14,526 Bytes
1f21206 | 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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 | /**
* Skills REST API
*
* GET /api/skills β List all installed skills (metadata only)
* GET /api/skills/detail β Full skill data (tree + files)
* ?source=user&name=xxx
*/
import * as path from 'path'
import * as fs from 'fs/promises'
import { parseFrontmatter } from '../../utils/frontmatterParser.js'
import { getClaudeConfigHomeDir } from '../../utils/envUtils.js'
import { getProjectDirsUpToHome } from '../../utils/markdownConfigLoader.js'
import { getCwd } from '../../utils/cwd.js'
import { loadAllPlugins, loadAllPluginsCacheOnly } from '../../utils/plugins/pluginLoader.js'
import { getSkillDirCommands } from '../../skills/loadSkillsDir.js'
import type { LoadedPlugin } from '../../types/plugin.js'
import { ApiError, errorResponse } from '../middleware/errorHandler.js'
// βββ Types βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
type SkillMeta = {
name: string
displayName?: string
description: string
source: 'user' | 'project' | 'plugin'
userInvocable: boolean
version?: string
contentLength: number
hasDirectory: boolean
pluginName?: string
}
type SkillSource = SkillMeta['source']
type FileTreeNode = {
name: string
path: string
type: 'file' | 'directory'
children?: FileTreeNode[]
}
type SkillFile = {
path: string
content: string
language: string
frontmatter?: Record<string, unknown>
body?: string
isEntry?: boolean
}
// βββ Constants βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
const MAX_FILES = 50
const MAX_FILE_SIZE = 100 * 1024 // 100 KB
const SKIP_ENTRIES = new Set(['node_modules', '.git', '__pycache__', '.DS_Store'])
const LANG_MAP: Record<string, string> = {
md: 'markdown', ts: 'typescript', tsx: 'typescript',
js: 'javascript', jsx: 'javascript', json: 'json',
yaml: 'yaml', yml: 'yaml', sh: 'bash', bash: 'bash',
py: 'python', toml: 'toml', css: 'css', html: 'html',
txt: 'text', xml: 'xml', sql: 'sql', rs: 'rust', go: 'go',
}
// βββ Helpers βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function detectLanguage(filename: string): string {
const ext = filename.split('.').pop()?.toLowerCase() || ''
return LANG_MAP[ext] || 'text'
}
function normalizeFrontmatter(content: string, sourcePath?: string): {
frontmatter: Record<string, unknown>
body: string
} {
const parsed = parseFrontmatter(content, sourcePath)
return {
frontmatter: parsed.frontmatter as Record<string, unknown>,
body: parsed.content,
}
}
function getUserSkillsDir(): string {
return path.join(getClaudeConfigHomeDir(), 'skills')
}
function getRequestedCwd(url: URL): string {
return url.searchParams.get('cwd') || getCwd()
}
function getProjectSkillsDirs(cwd: string): string[] {
return getProjectDirsUpToHome('skills', cwd)
}
async function loadSkillMeta(
skillDir: string,
skillName: string,
source: SkillSource,
pluginName?: string,
): Promise<SkillMeta | null> {
const skillFile = path.join(skillDir, 'SKILL.md')
try {
const raw = await fs.readFile(skillFile, 'utf-8')
const { frontmatter, body } = normalizeFrontmatter(raw, skillFile)
const description =
(frontmatter.description as string) ||
body
.split('\n')
.find((l) => l.trim().length > 0)
?.trim() ||
'No description'
return {
name: skillName,
displayName: (frontmatter.name as string) || undefined,
description,
source,
userInvocable: frontmatter['user-invocable'] !== false,
version: frontmatter.version != null ? String(frontmatter.version) : undefined,
contentLength: raw.length,
hasDirectory: true,
pluginName,
}
} catch {
return null
}
}
async function buildFileTree(
dirPath: string,
): Promise<{ tree: FileTreeNode[]; files: SkillFile[] }> {
const tree: FileTreeNode[] = []
const files: SkillFile[] = []
let fileCount = 0
async function walk(currentPath: string, nodes: FileTreeNode[]) {
if (fileCount >= MAX_FILES) return
let entries: import('fs').Dirent[]
try {
entries = await fs.readdir(currentPath, { withFileTypes: true })
} catch {
return
}
// directories first, then alphabetical
entries.sort((a, b) => {
if (a.isDirectory() !== b.isDirectory()) return a.isDirectory() ? -1 : 1
return a.name.localeCompare(b.name)
})
for (const entry of entries) {
if (fileCount >= MAX_FILES) break
if (SKIP_ENTRIES.has(entry.name) || entry.name.startsWith('.')) continue
const fullPath = path.join(currentPath, entry.name)
const relPath = path.relative(dirPath, fullPath)
if (entry.isDirectory()) {
const node: FileTreeNode = {
name: entry.name,
path: relPath,
type: 'directory',
children: [],
}
nodes.push(node)
await walk(fullPath, node.children!)
if (node.children!.length === 0) delete node.children
} else if (entry.isFile()) {
nodes.push({ name: entry.name, path: relPath, type: 'file' })
try {
const stat = await fs.stat(fullPath)
if (stat.size <= MAX_FILE_SIZE) {
const content = await fs.readFile(fullPath, 'utf-8')
const language = detectLanguage(entry.name)
const isEntry = relPath === 'SKILL.md'
if (isEntry && language === 'markdown') {
const { frontmatter, body } = normalizeFrontmatter(content, fullPath)
files.push({
path: relPath,
content: body,
body,
frontmatter,
language,
isEntry: true,
})
} else {
files.push({
path: relPath,
content,
language,
isEntry: false,
})
}
fileCount++
}
} catch {
// skip unreadable files
}
}
}
}
await walk(dirPath, tree)
return { tree, files }
}
async function collectSkillsFromRoots(
skillRoots: string[],
source: SkillSource,
): Promise<SkillMeta[]> {
const skills: SkillMeta[] = []
const seenNames = new Set<string>()
for (const root of skillRoots) {
let entries: import('fs').Dirent[]
try {
entries = await fs.readdir(root, { withFileTypes: true })
} catch {
continue
}
for (const entry of entries) {
if (
(!entry.isDirectory() && !entry.isSymbolicLink()) ||
entry.name.startsWith('.') ||
seenNames.has(entry.name)
) {
continue
}
const meta = await loadSkillMeta(path.join(root, entry.name), entry.name, source)
if (!meta) continue
seenNames.add(entry.name)
skills.push(meta)
}
}
return skills
}
async function resolveSkillDir(
source: SkillSource,
name: string,
cwd: string,
): Promise<string | null> {
const skillRoots =
source === 'user'
? [getUserSkillsDir()]
: source === 'project'
? getProjectSkillsDirs(cwd)
: []
for (const root of skillRoots) {
const skillDir = path.join(root, name)
try {
const stat = await fs.stat(skillDir)
if (stat.isDirectory()) {
return skillDir
}
} catch {
// Try the next candidate root.
}
}
return null
}
type PluginSkillLocation = {
skillDir: string
pluginName: string
}
export type SkillSlashCommand = {
name: string
description: string
argumentHint?: string
}
async function collectLegacySlashCommands(cwd: string): Promise<SkillSlashCommand[]> {
const commands = await getSkillDirCommands(cwd)
return commands
.filter((command) =>
command.type === 'prompt' &&
command.loadedFrom === 'commands_DEPRECATED' &&
command.userInvocable !== false &&
!command.isHidden)
.map((command) => ({
name: command.name,
description: command.description || '',
...(command.argumentHint ? { argumentHint: command.argumentHint } : {}),
}))
}
function buildPluginSkillName(pluginName: string, skillDir: string): string {
return `${pluginName}:${path.basename(skillDir)}`
}
async function collectPluginSkillDirectories(): Promise<Map<string, PluginSkillLocation>> {
const locations = new Map<string, PluginSkillLocation>()
let enabledPlugins: LoadedPlugin[]
try {
const result = await loadAllPluginsCacheOnly()
if (result.errors.some((error) => error.type === 'plugin-cache-miss')) {
enabledPlugins = (await loadAllPlugins()).enabled
} else {
enabledPlugins = result.enabled
}
} catch {
return locations
}
for (const plugin of enabledPlugins) {
const candidateRoots = [plugin.skillsPath, ...(plugin.skillsPaths ?? [])]
for (const root of candidateRoots) {
if (!root) continue
const directSkillFile = path.join(root, 'SKILL.md')
try {
const stat = await fs.stat(directSkillFile)
if (stat.isFile()) {
const name = buildPluginSkillName(plugin.name, root)
if (!locations.has(name)) {
locations.set(name, { skillDir: root, pluginName: plugin.name })
}
continue
}
} catch {
// Fall through and inspect as a skills root.
}
let entries: import('fs').Dirent[]
try {
entries = await fs.readdir(root, { withFileTypes: true })
} catch {
continue
}
for (const entry of entries) {
if (!entry.isDirectory() && !entry.isSymbolicLink()) continue
const skillDir = path.join(root, entry.name)
const skillFile = path.join(skillDir, 'SKILL.md')
try {
const stat = await fs.stat(skillFile)
if (!stat.isFile()) continue
} catch {
continue
}
const name = buildPluginSkillName(plugin.name, skillDir)
if (!locations.has(name)) {
locations.set(name, { skillDir, pluginName: plugin.name })
}
}
}
}
return locations
}
async function collectPluginSkills(): Promise<SkillMeta[]> {
const locations = await collectPluginSkillDirectories()
const skills: SkillMeta[] = []
for (const [name, location] of locations) {
const meta = await loadSkillMeta(
location.skillDir,
name,
'plugin',
location.pluginName,
)
if (meta) {
skills.push(meta)
}
}
return skills
}
async function collectAllSkills(cwd?: string): Promise<SkillMeta[]> {
const [userSkills, projectSkills, pluginSkills] = await Promise.all([
collectSkillsFromRoots([getUserSkillsDir()], 'user'),
collectSkillsFromRoots(getProjectSkillsDirs(cwd), 'project'),
collectPluginSkills(),
])
const skills = [...userSkills, ...projectSkills, ...pluginSkills]
skills.sort((a, b) => a.name.localeCompare(b.name))
return skills
}
export async function listSkillSlashCommands(cwd?: string): Promise<SkillSlashCommand[]> {
const requestedCwd = cwd || getCwd()
const [skills, legacyCommands] = await Promise.all([
collectAllSkills(requestedCwd),
collectLegacySlashCommands(requestedCwd),
])
const byName = new Map<string, SkillSlashCommand>()
for (const skill of skills) {
if (!skill.userInvocable) continue
byName.set(skill.name, {
name: skill.name,
description: skill.description || '',
})
}
for (const command of legacyCommands) {
if (!byName.has(command.name)) {
byName.set(command.name, command)
}
}
return [...byName.values()].sort((a, b) => a.name.localeCompare(b.name))
}
// βββ Router ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
export async function handleSkillsApi(
req: Request,
url: URL,
segments: string[],
): Promise<Response> {
try {
if (req.method !== 'GET') {
throw new ApiError(405, `Method ${req.method} not allowed`, 'METHOD_NOT_ALLOWED')
}
const sub = segments[2]
switch (sub) {
case undefined:
return await listSkills(url)
case 'detail':
return await getSkillDetail(url)
default:
throw ApiError.notFound(`Unknown skills endpoint: ${sub}`)
}
} catch (error) {
return errorResponse(error)
}
}
// βββ Handlers ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
async function listSkills(url: URL): Promise<Response> {
const cwd = getRequestedCwd(url)
const skills = await collectAllSkills(cwd)
return Response.json({ skills })
}
async function getSkillDetail(url: URL): Promise<Response> {
const source = url.searchParams.get('source')
const name = url.searchParams.get('name')
if (!source || !name) {
throw ApiError.badRequest('Missing required query parameters: source, name')
}
// Prevent path traversal
if (name.includes('..') || name.includes('/') || name.includes('\\')) {
throw ApiError.badRequest('Invalid skill name')
}
if (source !== 'user' && source !== 'project' && source !== 'plugin') {
throw ApiError.badRequest(`Unsupported source: ${source}`)
}
const cwd = getRequestedCwd(url)
const pluginLocations =
source === 'plugin' ? await collectPluginSkillDirectories() : null
const pluginLocation = pluginLocations?.get(name)
const skillDir =
source === 'plugin'
? pluginLocation?.skillDir ?? null
: await resolveSkillDir(source, name, cwd)
if (!skillDir) {
throw ApiError.notFound(`Skill not found: ${name}`)
}
const meta = await loadSkillMeta(
skillDir,
name,
source,
pluginLocation?.pluginName,
)
if (!meta) {
throw ApiError.notFound(`Skill missing SKILL.md: ${name}`)
}
const { tree, files } = await buildFileTree(skillDir)
return Response.json({
detail: { meta, tree, files, skillRoot: skillDir },
})
}
|