Class SkillDescriptionRule
- All Implemented Interfaces:
AgentDocsValidationRule
description frontmatter length.
Presence is not required: per the Agent Docs convention, an author's description is
appended to a resolver-generated prefix when present, so omitting it entirely (or omitting
frontmatter altogether) is valid and the resolver's generated description still applies.
The cap is well under the Agent Skills format's own 1024-character description limit,
reserving headroom for the resolver-generated prefix sentence prepended ahead of the author's
text (see SkillDirectoryManager.buildDescription in the resolve plugin). This rule
deliberately doesn't compute the resolver's exact prefix length itself - that would couple the
publish and resolve plugins' string formats together - it just reserves a conservative fixed
margin comfortably larger than any prefix the resolver is expected to generate.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionid()Stable rule identifier used for opt-out configuration.validate(ValidationContext context) Validates the docs using the provided context.
-
Constructor Details
-
SkillDescriptionRule
public SkillDescriptionRule()
-
-
Method Details
-
id
Description copied from interface:AgentDocsValidationRuleStable rule identifier used for opt-out configuration.- Specified by:
idin interfaceAgentDocsValidationRule- Returns:
- rule ID
-
validate
Description copied from interface:AgentDocsValidationRuleValidates the docs using the provided context.- Specified by:
validatein interfaceAgentDocsValidationRule- Parameters:
context- validation context- Returns:
- validation result including rule ID and any failure details
-