docstrings

This commit is contained in:
John Lancaster
2026-06-21 16:15:37 -05:00
parent 3a6e2665dd
commit 2d65d83162
5 changed files with 39 additions and 2 deletions
+11 -2
View File
@@ -1,4 +1,5 @@
from collections.abc import Mapping
from pathlib import PurePosixPath
from pydantic import Field
from pydantic import field_validator
@@ -13,6 +14,8 @@ type ToolSelector = str | tuple[str, ...]
class SkillMetadata(StrictFrozenModel):
"""Canonical metadata describing a skill and its dependencies."""
id: str
version: str
tags: tuple[str, ...] = ()
@@ -65,6 +68,8 @@ class SkillMetadata(StrictFrozenModel):
class SkillFrontmatter(StrictFrozenModel):
"""Parsed SKILL frontmatter including standard and personal-mcp fields."""
name: str = Field(min_length=1, max_length=64)
description: str = Field(min_length=1, max_length=1024)
when_to_use: str | None = None
@@ -103,14 +108,18 @@ class SkillFrontmatter(StrictFrozenModel):
class SkillDocumentModel(StrictFrozenModel):
"""Structured representation of a skill markdown document."""
skill_id: str
relpath: str
relpath: PurePosixPath
content: str
frontmatter: SkillFrontmatter
class SkillReferenceDocumentModel(StrictFrozenModel):
"""Structured representation of a skill reference markdown document."""
ref_id: str
relpath: str
relpath: PurePosixPath
content: str
entry: ReferenceEntry