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
@@ -22,6 +22,8 @@ type PromptArgumentType = Literal[
class PromptArgumentEntry(StrictFrozenModel):
"""Schema for a single prompt argument definition."""
type: PromptArgumentType
description: str | None = None
required: bool = False
@@ -37,6 +39,8 @@ class PromptArgumentEntry(StrictFrozenModel):
class PromptMetadata(StrictFrozenModel):
"""Canonical metadata describing a prompt contract and arguments."""
id: str
version: str
tags: tuple[str, ...] = ()
@@ -80,6 +84,8 @@ class PromptMetadata(StrictFrozenModel):
class PromptFrontmatter(StrictFrozenModel):
"""Parsed PROMPT frontmatter including personal-mcp metadata."""
name: str = Field(min_length=1, max_length=64)
description: str = Field(min_length=1, max_length=1024)
x_personal_mcp: PromptMetadata = Field(alias="x-personal-mcp")
@@ -95,6 +101,8 @@ class PromptFrontmatter(StrictFrozenModel):
class PromptDocumentModel(StrictFrozenModel):
"""Structured representation of a prompt markdown document."""
prompt_id: str
relpath: str
content: str