agent_skill_parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb27507d0523f0c0bb623a65b8817074f30f0c33bf415acfa29c16dd25e4d999
-  data.tar.gz: 13913b040ccc6fd706c9ed5d7bd79d00ef6d1ca46c988fa6d5033e06db9dfc68
+  metadata.gz: 2224c369e94618cede997892493c8b809422e05668f0101fabf02eecd5b41859
+  data.tar.gz: f7f78dbcd3e8784e97ecf66264895f2dc1869c6ca7a2f3f8b6893617b8199b01
 SHA512:
-  metadata.gz: 2ba5711dcaa15a855e53a45332f420c3d0c917e3d784468060ed3f7ce4c109eedbf90bdd88f04845402d165b55704403c63b40324cb641020dfd5dea6ee0fba3
-  data.tar.gz: 2b40d143d5f582a5d805887511d726dd849fffa5fced18f3f47bd11b1826e8a41503a32d4b69bcf681e236c9bbd06c2ec7518dbef9ee7f399994f2b5ec33ecac
+  metadata.gz: 5005b0fe0044f0950c9386cc238b030b4165b72f9a85de12385e8d0f44ee1f374bd15fbe6f04b5cd89a37079b77865cca0c66353f12c3ec35aad8e3718ededef
+  data.tar.gz: fcc54de836504d1afdbb8f7afb9ee0c7ff4e5d8f348f41599609935256482b6f80b2d353333aa378da7c6e15a8681f56aecfce915f3641bb4e5687f6c1faa85e

data/.yardopts

@@ -9,4 +9,4 @@ lib/**/*.rb
 -
 README.md
 CHANGELOG.md
-LICENSE.txt
+LICENSE

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## [Unreleased]
+## [0.2.0] - 2026-02-01
+
+- Added `generate_llm.rb` script to generate LLM content
+- Improved documentation across all modules
+- Generated LLM.txt documentation file
 
 ## [0.1.0] - 2026-01-29
 

data/README.md

@@ -3,7 +3,8 @@
 A Ruby gem for parsing skill files that use YAML frontmatter and markdown body content. Designed for agent/AI systems where skills are defined as structured markdown documents with metadata.
 
 Warning: 
-- This gem does not protect against Prompt Injection. It only parses the structure of the skill according with the specification from https://agentskills.io/specification
+- This gem does not protect against Prompt Injection so if you read with this a skill file and pipe it through an LLM it will send there the exact skill file without any filtering. 
+- It only parses the structure of the skill according with the specification from https://agentskills.io/specification
 
 ## Installation
 

data/doc/AgentSkillParser/AllowedTool.md

@@ -0,0 +1,28 @@
+# Class: AgentSkillParser::AllowedTool
+**Inherits:** Data
+    
+
+Represents an allowed tool with optional regex pattern. Pattern is used to
+match tool arguments in skill files (e.g., git:* for git commands).
+
+
+**@example**
+```ruby
+AllowedTool.new(name: "search_files", pattern: "\\.(rb|js)$")
+```
+**@example**
+```ruby
+AllowedTool.new(name: "bash", pattern: nil)
+```
+# Attributes
+## name[RW] [](#attribute-i-name)
+Returns the value of attribute name
+
+**@return** [Object] the current value of name
+
+## pattern[RW] [](#attribute-i-pattern)
+Returns the value of attribute pattern
+
+**@return** [Object] the current value of pattern
+
+

data/doc/AgentSkillParser/AllowedToolsParser.md

@@ -0,0 +1,33 @@
+# Class: AgentSkillParser::AllowedToolsParser
+**Inherits:** Object
+    
+
+Parses tool names with optional regex patterns for arguments.
+
+Format: `ToolName` or `ToolName(pattern)` where pattern is optional. Multiple
+tools are space or comma separated.
+
+
+**@example**
+```ruby
+parser = AllowedToolsParser.new("bash, search_files(\\.rb$)")
+parser.call
+# => [
+#      AllowedTool.new(name: "bash", pattern: nil),
+#      AllowedTool.new(name: "search_files", pattern: "\\.rb$")
+#    ]
+```
+
+# Instance Methods
+## call() [](#method-i-call)
+
+**@return** [Array<AllowedTool>] parsed tool definitions
+
+**@see** [] 
+
+## initialize(string) [](#method-i-initialize)
+
+**@param** [String] comma-separated tool list
+
+**@return** [AllowedToolsParser] a new instance of AllowedToolsParser
+

data/doc/AgentSkillParser/DocumentSplitter/RawYamlDocument.md

@@ -0,0 +1,20 @@
+# Class: AgentSkillParser::DocumentSplitter::RawYamlDocument
+**Inherits:** Data
+    
+
+Represents a raw YAML document with separated YAML frontmatter and body. Used
+as an intermediate structure during parsing.
+
+
+# Attributes
+## body[RW] [](#attribute-i-body)
+Returns the value of attribute body
+
+**@return** [Object] the current value of body
+
+## yaml_string[RW] [](#attribute-i-yaml_string)
+Returns the value of attribute yaml_string
+
+**@return** [Object] the current value of yaml_string
+
+

data/doc/AgentSkillParser/DocumentSplitter.md

@@ -0,0 +1,42 @@
+# Class: AgentSkillParser::DocumentSplitter
+**Inherits:** Object
+    
+
+Splits a markdown document into YAML frontmatter and body.
+
+
+**@example**
+```ruby
+splitter = DocumentSplitter.new("---\nname: skill\n---\n# Body")
+result = splitter.call
+result.yaml_string # => "name: skill"
+result.body # => "# Body"
+```
+**@example**
+```ruby
+splitter = DocumentSplitter.new("# Just body")
+result = splitter.call
+result.yaml_string # => ""
+result.body # => "# Just body"
+```
+# Attributes
+## body[RW] [](#attribute-i-body)
+
+**@return** [String] Markdown body content
+
+## yaml_string[RW] [](#attribute-i-yaml_string)
+
+**@return** [String] YAML frontmatter content
+
+
+# Instance Methods
+## call() [](#method-i-call)
+
+**@return** [RawYamlDocument] 
+
+## initialize(text) [](#method-i-initialize)
+
+**@param** [String] full document content
+
+**@return** [DocumentSplitter] a new instance of DocumentSplitter
+

data/doc/AgentSkillParser/Errors/Base.md

@@ -0,0 +1,8 @@
+# Exception: AgentSkillParser::Errors::Base
+**Inherits:** StandardError
+    
+
+Base class for all parser exceptions.
+
+
+

data/doc/AgentSkillParser/Errors/Parser.md

@@ -0,0 +1,18 @@
+# Exception: AgentSkillParser::Errors::Parser
+**Inherits:** AgentSkillParser::Errors::Base
+    
+
+Raised when parsing fails.
+
+Raised for: invalid YAML, missing frontmatter, file not found
+
+
+**@example**
+```ruby
+begin
+  AgentSkillParser.parse("invalid.md")
+rescue AgentSkillParser::Errors::Parser => e
+  puts "Parsing error: #{e.message}"
+end
+```
+

data/doc/AgentSkillParser/Errors/Validation.md

@@ -0,0 +1,19 @@
+# Exception: AgentSkillParser::Errors::Validation
+**Inherits:** AgentSkillParser::Errors::Base
+    
+
+Raised when frontmatter validation fails.
+
+Raised for: invalid name format, description too long/short, compatibility too
+long
+
+
+**@example**
+```ruby
+begin
+  AgentSkillParser.parse("skill.md")
+rescue AgentSkillParser::Errors::Validation => e
+  puts "Validation error: #{e.message}"
+end
+```
+

data/doc/AgentSkillParser/Errors.md

@@ -0,0 +1,7 @@
+# Module: AgentSkillParser::Errors
+    
+
+Namespace for all parser exceptions.
+
+
+

data/doc/AgentSkillParser/Frontmatter.md

@@ -0,0 +1,50 @@
+# Class: AgentSkillParser::Frontmatter
+**Inherits:** Data
+    
+
+Parsed frontmatter data from a skill file.
+
+
+**@example**
+```ruby
+Frontmatter.new(
+  name: "my-skill",
+  description: "A useful skill",
+  license: "MIT",
+  compatibility: "v1.2.3+",
+  metadata: { "author" => "Alice" },
+  allowed_tools: [AllowedTool.new(name: "bash", pattern: nil)]
+)
+```
+# Attributes
+## allowed_tools[RW] [](#attribute-i-allowed_tools)
+Returns the value of attribute allowed_tools
+
+**@return** [Object] the current value of allowed_tools
+
+## compatibility[RW] [](#attribute-i-compatibility)
+Returns the value of attribute compatibility
+
+**@return** [Object] the current value of compatibility
+
+## description[RW] [](#attribute-i-description)
+Returns the value of attribute description
+
+**@return** [Object] the current value of description
+
+## license[RW] [](#attribute-i-license)
+Returns the value of attribute license
+
+**@return** [Object] the current value of license
+
+## metadata[RW] [](#attribute-i-metadata)
+Returns the value of attribute metadata
+
+**@return** [Object] the current value of metadata
+
+## name[RW] [](#attribute-i-name)
+Returns the value of attribute name
+
+**@return** [Object] the current value of name
+
+

data/doc/AgentSkillParser/FrontmatterParser.md

@@ -0,0 +1,26 @@
+# Class: AgentSkillParser::FrontmatterParser
+**Inherits:** Object
+    
+
+Parses YAML frontmatter into a {Frontmatter} object.
+
+
+**@example**
+```ruby
+parser = FrontmatterParser.new("name: my-skill\ndescription: A skill")
+parser.call # => Frontmatter.new(name: "my-skill", description: "A skill", ...)
+```
+
+# Instance Methods
+## call() [](#method-i-call)
+
+**@raise** [Errors::Parser] if YAML is invalid
+
+**@return** [Frontmatter] parsed frontmatter data
+
+## initialize(yaml_string) [](#method-i-initialize)
+
+**@param** [String] YAML content (may be empty)
+
+**@return** [FrontmatterParser] a new instance of FrontmatterParser
+

data/doc/AgentSkillParser/Parser.md

@@ -0,0 +1,35 @@
+# Class: AgentSkillParser::Parser
+**Inherits:** Object
+    
+
+Orchestrates the parsing pipeline for skill files.
+
+Pipeline stages: DocumentSplitter → FrontmatterParser → Validator → Skill
+construction
+
+
+**@example**
+```ruby
+parser = Parser.new("my_skill.md")
+skill = parser.call
+skill.name # => "my-skill"
+skill.body # => "# My Skill..."
+```
+
+# Instance Methods
+## call() [](#method-i-call)
+
+**@raise** [Errors::Parser] if YAML is invalid or file cannot be read
+
+**@raise** [Errors::Validation] if frontmatter fails validation
+
+**@raise** [Errno::ENOENT] if file does not exist
+
+**@return** [Skill] parsed skill object
+
+## initialize(file_path) [](#method-i-initialize)
+
+**@param** [String] path to skill file
+
+**@return** [Parser] a new instance of Parser
+

data/doc/AgentSkillParser/Skill.md

@@ -0,0 +1,35 @@
+# Class: AgentSkillParser::Skill
+**Inherits:** Data
+    
+
+A parsed skill with frontmatter and body.
+
+
+**@example**
+```ruby
+Skill.new(
+  frontmatter: Frontmatter.new(name: "skill", description: "...", ...),
+  body: "# My Skill\n\n..."
+)
+```
+# Attributes
+## body[RW] [](#attribute-i-body)
+Returns the value of attribute body
+
+**@return** [Object] the current value of body
+
+## frontmatter[RW] [](#attribute-i-frontmatter)
+Returns the value of attribute frontmatter
+
+**@return** [Object] the current value of frontmatter
+
+
+# Instance Methods
+## description() [](#method-i-description)
+
+**@return** [String] skill description (delegates to frontmatter)
+
+## name() [](#method-i-name)
+
+**@return** [String] skill name (delegates to frontmatter)
+

data/doc/AgentSkillParser/Validator.md

@@ -0,0 +1,37 @@
+# Class: AgentSkillParser::Validator
+**Inherits:** Object
+    
+
+Validates frontmatter data against schema rules.
+
+Validation rules:
+*   Name: 1-64 chars, lowercase letters/numbers/hyphens only, no consecutive
+    hyphens, cannot start/end with hyphen
+*   Description: 1-1024 characters
+*   Compatibility: optional, max 500 characters
+
+
+**@example**
+```ruby
+fm = Frontmatter.new(name: "skill", description: "A skill", ...)
+Validator.new(fm).call # => nil (no error)
+```
+**@example**
+```ruby
+fm = Frontmatter.new(name: "Bad Name!", description: "...", ...)
+Validator.new(fm).call # => raises Errors::Validation
+```
+
+# Instance Methods
+## call() [](#method-i-call)
+
+**@raise** [Errors::Validation] if validation fails
+
+**@return** [void] 
+
+## initialize(frontmatter) [](#method-i-initialize)
+
+**@param** [Frontmatter] parsed frontmatter data
+
+**@return** [Validator] a new instance of Validator
+

data/doc/AgentSkillParser.md

@@ -0,0 +1,98 @@
+# Module: AgentSkillParser
+    
+
+Parses skill files with YAML frontmatter and markdown body.
+
+Skill file format: ```markdown
+---
+name: my-skill description: A helpful skill license: MIT compatibility:
+v1.2.3+ metadata:
+    author: Alice
+
+allowed-tools: bash, search_files(.rb$)
+---
+# My Skill
+
+Body content here... ```
+
+
+**@example**
+```ruby
+skill = AgentSkillParser.parse("my_skill.md")
+skill.name # => "my-skill"
+skill.description # => "A helpful skill"
+```
+**@example**
+```ruby
+begin
+  AgentSkillParser.parse("invalid.md")
+rescue AgentSkillParser::Errors::Parser => e
+  puts "Parse error: #{e.message}"
+rescue AgentSkillParser::Errors::Validation => e
+  puts "Validation error: #{e.message}"
+end
+```
+# Class Methods
+## parse(file_path ) [](#method-c-parse)
+**@param** [String] path to skill file
+
+**@raise** [Errors::Parser] if YAML is invalid or file cannot be read
+
+**@raise** [Errors::Validation] if frontmatter fails validation
+
+**@raise** [Errno::ENOENT] if file does not exist
+
+**@return** [Skill] parsed skill object
+
+# Attributes
+## allowed_tools[RW] [](#attribute-i-allowed_tools)
+
+**@return** [Array<AllowedTool>] list of allowed tools
+
+## body[RW] [](#attribute-i-body)
+
+**@return** [String] markdown content after frontmatter
+
+## compatibility[RW] [](#attribute-i-compatibility)
+
+**@return** [String, nil] compatibility notes (optional)
+
+## description[RW] [](#attribute-i-description)
+
+**@return** [String] human-readable description
+
+## frontmatter[RW] [](#attribute-i-frontmatter)
+
+**@return** [Frontmatter] parsed metadata
+
+## license[RW] [](#attribute-i-license)
+
+**@return** [String, nil] license name (optional)
+
+## metadata[RW] [](#attribute-i-metadata)
+
+**@return** [Hash{String => String}] custom key-value metadata
+
+## name[RW] [](#attribute-i-name)
+
+**@return** [String] tool name (e.g., "bash")
+
+## pattern[RW] [](#attribute-i-pattern)
+
+**@return** [String, nil] optional regex pattern for arguments
+
+# Documentation
+
+- [AgentSkillParser/AllowedTool.md](AgentSkillParser/AllowedTool.md)
+- [AgentSkillParser/AllowedToolsParser.md](AgentSkillParser/AllowedToolsParser.md)
+- [AgentSkillParser/DocumentSplitter.md](AgentSkillParser/DocumentSplitter.md)
+- [AgentSkillParser/DocumentSplitter/RawYamlDocument.md](AgentSkillParser/DocumentSplitter/RawYamlDocument.md)
+- [AgentSkillParser/Errors.md](AgentSkillParser/Errors.md)
+- [AgentSkillParser/Errors/Base.md](AgentSkillParser/Errors/Base.md)
+- [AgentSkillParser/Errors/Parser.md](AgentSkillParser/Errors/Parser.md)
+- [AgentSkillParser/Errors/Validation.md](AgentSkillParser/Errors/Validation.md)
+- [AgentSkillParser/Frontmatter.md](AgentSkillParser/Frontmatter.md)
+- [AgentSkillParser/FrontmatterParser.md](AgentSkillParser/FrontmatterParser.md)
+- [AgentSkillParser/Parser.md](AgentSkillParser/Parser.md)
+- [AgentSkillParser/Skill.md](AgentSkillParser/Skill.md)
+- [AgentSkillParser/Validator.md](AgentSkillParser/Validator.md)

data/doc/index.csv

@@ -0,0 +1,51 @@
+name,type,path
+AgentSkillParser,Module,AgentSkillParser.md
+AgentSkillParser.parse,Method,AgentSkillParser.md#method-c-parse
+allowed_tools,Attribute,AgentSkillParser.md#attribute-i-allowed_tools
+body,Attribute,AgentSkillParser.md#attribute-i-body
+compatibility,Attribute,AgentSkillParser.md#attribute-i-compatibility
+description,Attribute,AgentSkillParser.md#attribute-i-description
+frontmatter,Attribute,AgentSkillParser.md#attribute-i-frontmatter
+license,Attribute,AgentSkillParser.md#attribute-i-license
+metadata,Attribute,AgentSkillParser.md#attribute-i-metadata
+name,Attribute,AgentSkillParser.md#attribute-i-name
+pattern,Attribute,AgentSkillParser.md#attribute-i-pattern
+AgentSkillParser::Errors,Module,AgentSkillParser/Errors.md
+AgentSkillParser::Skill,Class,AgentSkillParser/Skill.md
+AgentSkillParser::Skill.description,Method,AgentSkillParser/Skill.md#method-i-description
+AgentSkillParser::Skill.name,Method,AgentSkillParser/Skill.md#method-i-name
+body,Attribute,AgentSkillParser/Skill.md#attribute-i-body
+frontmatter,Attribute,AgentSkillParser/Skill.md#attribute-i-frontmatter
+AgentSkillParser::Parser,Class,AgentSkillParser/Parser.md
+AgentSkillParser::Parser.call,Method,AgentSkillParser/Parser.md#method-i-call
+AgentSkillParser::Parser.initialize,Method,AgentSkillParser/Parser.md#method-i-initialize
+AgentSkillParser::Validator,Class,AgentSkillParser/Validator.md
+AgentSkillParser::Validator.call,Method,AgentSkillParser/Validator.md#method-i-call
+AgentSkillParser::Validator.initialize,Method,AgentSkillParser/Validator.md#method-i-initialize
+AgentSkillParser::Errors::Base,Class,AgentSkillParser/Errors/Base.md
+AgentSkillParser::Frontmatter,Class,AgentSkillParser/Frontmatter.md
+allowed_tools,Attribute,AgentSkillParser/Frontmatter.md#attribute-i-allowed_tools
+compatibility,Attribute,AgentSkillParser/Frontmatter.md#attribute-i-compatibility
+description,Attribute,AgentSkillParser/Frontmatter.md#attribute-i-description
+license,Attribute,AgentSkillParser/Frontmatter.md#attribute-i-license
+metadata,Attribute,AgentSkillParser/Frontmatter.md#attribute-i-metadata
+name,Attribute,AgentSkillParser/Frontmatter.md#attribute-i-name
+AgentSkillParser::AllowedTool,Class,AgentSkillParser/AllowedTool.md
+name,Attribute,AgentSkillParser/AllowedTool.md#attribute-i-name
+pattern,Attribute,AgentSkillParser/AllowedTool.md#attribute-i-pattern
+AgentSkillParser::Errors::Parser,Class,AgentSkillParser/Errors/Parser.md
+AgentSkillParser::DocumentSplitter,Class,AgentSkillParser/DocumentSplitter.md
+AgentSkillParser::DocumentSplitter.call,Method,AgentSkillParser/DocumentSplitter.md#method-i-call
+AgentSkillParser::DocumentSplitter.initialize,Method,AgentSkillParser/DocumentSplitter.md#method-i-initialize
+body,Attribute,AgentSkillParser/DocumentSplitter.md#attribute-i-body
+yaml_string,Attribute,AgentSkillParser/DocumentSplitter.md#attribute-i-yaml_string
+AgentSkillParser::DocumentSplitter::RawYamlDocument,Class,AgentSkillParser/DocumentSplitter/RawYamlDocument.md
+body,Attribute,AgentSkillParser/DocumentSplitter/RawYamlDocument.md#attribute-i-body
+yaml_string,Attribute,AgentSkillParser/DocumentSplitter/RawYamlDocument.md#attribute-i-yaml_string
+AgentSkillParser::Errors::Validation,Class,AgentSkillParser/Errors/Validation.md
+AgentSkillParser::FrontmatterParser,Class,AgentSkillParser/FrontmatterParser.md
+AgentSkillParser::FrontmatterParser.call,Method,AgentSkillParser/FrontmatterParser.md#method-i-call
+AgentSkillParser::FrontmatterParser.initialize,Method,AgentSkillParser/FrontmatterParser.md#method-i-initialize
+AgentSkillParser::AllowedToolsParser,Class,AgentSkillParser/AllowedToolsParser.md
+AgentSkillParser::AllowedToolsParser.call,Method,AgentSkillParser/AllowedToolsParser.md#method-i-call
+AgentSkillParser::AllowedToolsParser.initialize,Method,AgentSkillParser/AllowedToolsParser.md#method-i-initialize

data/lib/agent_skill_parser/allowed_tool.rb

@@ -2,16 +2,16 @@
 
 module AgentSkillParser
   # Represents an allowed tool with optional regex pattern.
+  # Pattern is used to match tool arguments in skill files (e.g., git:* for git commands).
   #
   # @!attribute [r] name
-  #   @return [String] the tool name (e.g., "bash")
+  #   @return [String] tool name (e.g., "bash")
   # @!attribute [r] pattern
   #   @return [String, nil] optional regex pattern for arguments
   #
-  # @example Tool without pattern
-  #   AllowedTool.new(name: "bash", pattern: nil)
-  #
   # @example Tool with pattern
   #   AllowedTool.new(name: "search_files", pattern: "\\.(rb|js)$")
+  # @example Tool without pattern
+  #   AllowedTool.new(name: "bash", pattern: nil)
   AllowedTool = Data.define(:name, :pattern)
 end

data/lib/agent_skill_parser/allowed_tools_parser.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module AgentSkillParser
-  # Parses tool names with optional argument patterns.
+  # Parses tool names with optional regex patterns for arguments.
+  #
+  # Format: `ToolName` or `ToolName(pattern)` where pattern is optional.
+  # Multiple tools are space or comma separated.
   #
   # @example Parse tools
   #   parser = AllowedToolsParser.new("bash, search_files(\\.rb$)")
@@ -11,7 +14,7 @@ module AgentSkillParser
   #   #      AllowedTool.new(name: "search_files", pattern: "\\.rb$")
   #   #    ]
   class AllowedToolsParser
-    # @return [Regexp] pattern matching "tool_name" or "tool_name(pattern)"
+    # Pattern matching "tool_name" or "tool_name(pattern)"
     TOOL_REGEX = /([A-Za-z_]\w*)(?:\(([^)]*)\))?/
 
     # @param string [String] comma-separated tool list

data/lib/agent_skill_parser/document_splitter.rb

@@ -5,13 +5,18 @@ module AgentSkillParser
   #
   # @example With frontmatter
   #   splitter = DocumentSplitter.new("---\nname: skill\n---\n# Body")
-  #   splitter.call # => ["name: skill", "# Body"]
+  #   result = splitter.call
+  #   result.yaml_string # => "name: skill"
+  #   result.body # => "# Body"
   #
   # @example Without frontmatter
   #   splitter = DocumentSplitter.new("# Just body")
-  #   splitter.call # => ["", "# Just body"]
+  #   result = splitter.call
+  #   result.yaml_string # => ""
+  #   result.body # => "# Just body"
   class DocumentSplitter
     # Represents a raw YAML document with separated YAML frontmatter and body.
+    # Used as an intermediate structure during parsing.
     #
     # @!attribute [r] yaml_string
     #   @return [String] YAML frontmatter content

data/lib/agent_skill_parser/errors/base.rb

@@ -3,8 +3,6 @@
 module AgentSkillParser
   module Errors
     # Base class for all parser exceptions.
-    #
-    # @abstract
     class Base < StandardError
     end
   end

data/lib/agent_skill_parser/errors/parser.rb

@@ -2,7 +2,9 @@
 
 module AgentSkillParser
   module Errors
-    # Raised when parsing fails (e.g., invalid YAML, file not found).
+    # Raised when parsing fails.
+    #
+    # Raised for: invalid YAML, missing frontmatter, file not found
     #
     # @example Rescue pattern
     #   begin
@@ -10,8 +12,6 @@ module AgentSkillParser
     #   rescue AgentSkillParser::Errors::Parser => e
     #     puts "Parsing error: #{e.message}"
     #   end
-    #
-    # @see FrontmatterParser#call
     class Parser < Base
     end
   end

data/lib/agent_skill_parser/errors/validation.rb

@@ -4,14 +4,14 @@ module AgentSkillParser
   module Errors
     # Raised when frontmatter validation fails.
     #
+    # Raised for: invalid name format, description too long/short, compatibility too long
+    #
     # @example Rescue pattern
     #   begin
     #     AgentSkillParser.parse("skill.md")
     #   rescue AgentSkillParser::Errors::Validation => e
     #     puts "Validation error: #{e.message}"
     #   end
-    #
-    # @see Validator#call
     class Validation < Base
     end
   end

data/lib/agent_skill_parser/errors.rb

@@ -2,10 +2,6 @@
 
 module AgentSkillParser
   # Namespace for all parser exceptions.
-  #
-  # @see Base
-  # @see Parser
-  # @see Validation
   module Errors
   end
 end

data/lib/agent_skill_parser/frontmatter.rb

@@ -25,12 +25,11 @@ module AgentSkillParser
   #     metadata: { "author" => "Alice" },
   #     allowed_tools: [AllowedTool.new(name: "bash", pattern: nil)]
   #   )
-  #
-  # @see FrontmatterParser
   Frontmatter = Data.define(:name, :description, :license, :compatibility, :metadata, :allowed_tools)
 
-  # A singleton nil object for empty frontmatter.
-  # Used when YAML frontmatter is missing or empty.
+  # Nil object for empty frontmatter.
+  # Returned by FrontmatterParser when YAML string is empty or missing.
+  # All fields are nil or empty to safely handle missing frontmatter.
   NilFrontmatter = Frontmatter.new(
     name: "",
     description: "",

data/lib/agent_skill_parser/frontmatter_parser.rb

@@ -28,12 +28,14 @@ module AgentSkillParser
     private
 
     # @return [Hash] parsed YAML data
+    # :nodoc:
     def parse_yaml
       YAML.safe_load(@yaml_string) || {}
     end
 
     # @param data [Hash] raw YAML data
     # @return [Frontmatter] constructed frontmatter
+    # :nodoc:
     def build_frontmatter(data)
       allowed_tools_data = data.delete("allowed-tools")
       metadata_data = data.delete("metadata") || {}
@@ -50,6 +52,7 @@ module AgentSkillParser
 
     # @param data [Object] metadata value
     # @return [Hash{String => String}] stringified metadata
+    # :nodoc:
     def coerce_metadata(data)
       return {} unless data.is_a?(Hash)
 
@@ -58,6 +61,7 @@ module AgentSkillParser
 
     # @param data [String, Array, nil] allowed-tools value
     # @return [Array<AllowedTool>] parsed tool list
+    # :nodoc:
     def parse_allowed_tools(data)
       return [] if data.nil? || data.empty?
 

data/lib/agent_skill_parser/parser.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
 module AgentSkillParser
-  # Main parser that orchestrates the parsing pipeline.
+  # Orchestrates the parsing pipeline for skill files.
   #
-  # Pipeline stages:
-  # 1. {DocumentSplitter} - Split YAML frontmatter from body
-  # 2. {FrontmatterParser} - Parse YAML into {Frontmatter}
-  # 3. {Validator} - Validate frontmatter schema
-  # 4. Construct {Skill} object
+  # Pipeline stages: DocumentSplitter → FrontmatterParser → Validator → Skill construction
   #
   # @example Parse a skill file
   #   parser = Parser.new("my_skill.md")

data/lib/agent_skill_parser/skill.rb

@@ -15,13 +15,11 @@ module AgentSkillParser
   #   )
   Skill = Data.define(:frontmatter, :body) do
     # @return [String] skill name (delegates to frontmatter)
-    # @see Frontmatter#name
     def name
       frontmatter.name
     end
 
     # @return [String] skill description (delegates to frontmatter)
-    # @see Frontmatter#description
     def description
       frontmatter.description
     end

data/lib/agent_skill_parser/validator.rb

@@ -3,6 +3,12 @@
 module AgentSkillParser
   # Validates frontmatter data against schema rules.
   #
+  # Validation rules:
+  # - Name: 1-64 chars, lowercase letters/numbers/hyphens only, no consecutive hyphens,
+  #   cannot start/end with hyphen
+  # - Description: 1-1024 characters
+  # - Compatibility: optional, max 500 characters
+  #
   # @example Successful validation
   #   fm = Frontmatter.new(name: "skill", description: "A skill", ...)
   #   Validator.new(fm).call # => nil (no error)
@@ -10,20 +16,18 @@ module AgentSkillParser
   # @example Failed validation
   #   fm = Frontmatter.new(name: "Bad Name!", description: "...", ...)
   #   Validator.new(fm).call # => raises Errors::Validation
-  #
-  # @see Errors::Validation
   class Validator
-    # @return [Integer] maximum name length
+    # Maximum name length
     NAME_MAX_LENGTH = 64
-    # @return [Integer] minimum name length
+    # Minimum name length
     NAME_MIN_LENGTH = 1
-    # @return [Regexp] allowed name pattern
+    # Allowed name pattern
     NAME_PATTERN = /\A[a-z0-9-]+\z/
-    # @return [Integer] maximum description length
+    # Maximum description length
     DESCRIPTION_MAX_LENGTH = 1024
-    # @return [Integer] minimum description length
+    # Minimum description length
     DESCRIPTION_MIN_LENGTH = 1
-    # @return [Integer] maximum compatibility length
+    # Maximum compatibility length
     COMPATIBILITY_MAX_LENGTH = 500
 
     # @param frontmatter [Frontmatter] parsed frontmatter data
@@ -43,6 +47,7 @@ module AgentSkillParser
 
     # @return [void]
     # @raise [Errors::Validation] if name is invalid
+    # :nodoc:
     def validate_name
       name = @frontmatter.name
 
@@ -63,6 +68,7 @@ module AgentSkillParser
 
     # @return [void]
     # @raise [Errors::Validation] if description is invalid
+    # :nodoc:
     def validate_description
       description = @frontmatter.description
 
@@ -77,6 +83,7 @@ module AgentSkillParser
 
     # @return [void]
     # @raise [Errors::Validation] if compatibility is too long
+    # :nodoc:
     def validate_compatibility
       return if @frontmatter.compatibility.nil?
 

data/lib/agent_skill_parser/version.rb

@@ -2,5 +2,5 @@
 
 module AgentSkillParser
   # @return [String] gem version
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/agent_skill_parser.rb

@@ -9,7 +9,7 @@ loader.setup
 # Parses skill files with YAML frontmatter and markdown body.
 #
 # Skill file format:
-# ```yaml
+# ```markdown
 # ---
 # name: my-skill
 # description: A helpful skill
@@ -43,7 +43,6 @@ module AgentSkillParser
   # @raise [Errors::Parser] if YAML is invalid or file cannot be read
   # @raise [Errors::Validation] if frontmatter fails validation
   # @raise [Errno::ENOENT] if file does not exist
-  # @see Parser#call
   def self.parse(file_path)
     Parser.new(file_path).call
   end

data/llm.txt

@@ -0,0 +1,98 @@
+# Module: AgentSkillParser
+    
+
+Parses skill files with YAML frontmatter and markdown body.
+
+Skill file format: ```markdown
+---
+name: my-skill description: A helpful skill license: MIT compatibility:
+v1.2.3+ metadata:
+    author: Alice
+
+allowed-tools: bash, search_files(.rb$)
+---
+# My Skill
+
+Body content here... ```
+
+
+**@example**
+```ruby
+skill = AgentSkillParser.parse("my_skill.md")
+skill.name # => "my-skill"
+skill.description # => "A helpful skill"
+```
+**@example**
+```ruby
+begin
+  AgentSkillParser.parse("invalid.md")
+rescue AgentSkillParser::Errors::Parser => e
+  puts "Parse error: #{e.message}"
+rescue AgentSkillParser::Errors::Validation => e
+  puts "Validation error: #{e.message}"
+end
+```
+# Class Methods
+## parse(file_path ) [](#method-c-parse)
+**@param** [String] path to skill file
+
+**@raise** [Errors::Parser] if YAML is invalid or file cannot be read
+
+**@raise** [Errors::Validation] if frontmatter fails validation
+
+**@raise** [Errno::ENOENT] if file does not exist
+
+**@return** [Skill] parsed skill object
+
+# Attributes
+## allowed_tools[RW] [](#attribute-i-allowed_tools)
+
+**@return** [Array<AllowedTool>] list of allowed tools
+
+## body[RW] [](#attribute-i-body)
+
+**@return** [String] markdown content after frontmatter
+
+## compatibility[RW] [](#attribute-i-compatibility)
+
+**@return** [String, nil] compatibility notes (optional)
+
+## description[RW] [](#attribute-i-description)
+
+**@return** [String] human-readable description
+
+## frontmatter[RW] [](#attribute-i-frontmatter)
+
+**@return** [Frontmatter] parsed metadata
+
+## license[RW] [](#attribute-i-license)
+
+**@return** [String, nil] license name (optional)
+
+## metadata[RW] [](#attribute-i-metadata)
+
+**@return** [Hash{String => String}] custom key-value metadata
+
+## name[RW] [](#attribute-i-name)
+
+**@return** [String] tool name (e.g., "bash")
+
+## pattern[RW] [](#attribute-i-pattern)
+
+**@return** [String, nil] optional regex pattern for arguments
+
+# Documentation
+
+- [doc/AgentSkillParser/AllowedTool.md](doc/AgentSkillParser/AllowedTool.md)
+- [doc/AgentSkillParser/AllowedToolsParser.md](doc/AgentSkillParser/AllowedToolsParser.md)
+- [doc/AgentSkillParser/DocumentSplitter.md](doc/AgentSkillParser/DocumentSplitter.md)
+- [doc/AgentSkillParser/DocumentSplitter/RawYamlDocument.md](doc/AgentSkillParser/DocumentSplitter/RawYamlDocument.md)
+- [doc/AgentSkillParser/Errors.md](doc/AgentSkillParser/Errors.md)
+- [doc/AgentSkillParser/Errors/Base.md](doc/AgentSkillParser/Errors/Base.md)
+- [doc/AgentSkillParser/Errors/Parser.md](doc/AgentSkillParser/Errors/Parser.md)
+- [doc/AgentSkillParser/Errors/Validation.md](doc/AgentSkillParser/Errors/Validation.md)
+- [doc/AgentSkillParser/Frontmatter.md](doc/AgentSkillParser/Frontmatter.md)
+- [doc/AgentSkillParser/FrontmatterParser.md](doc/AgentSkillParser/FrontmatterParser.md)
+- [doc/AgentSkillParser/Parser.md](doc/AgentSkillParser/Parser.md)
+- [doc/AgentSkillParser/Skill.md](doc/AgentSkillParser/Skill.md)
+- [doc/AgentSkillParser/Validator.md](doc/AgentSkillParser/Validator.md)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agent_skill_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lucian Ghinda
@@ -39,6 +39,21 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- doc/AgentSkillParser.md
+- doc/AgentSkillParser/AllowedTool.md
+- doc/AgentSkillParser/AllowedToolsParser.md
+- doc/AgentSkillParser/DocumentSplitter.md
+- doc/AgentSkillParser/DocumentSplitter/RawYamlDocument.md
+- doc/AgentSkillParser/Errors.md
+- doc/AgentSkillParser/Errors/Base.md
+- doc/AgentSkillParser/Errors/Parser.md
+- doc/AgentSkillParser/Errors/Validation.md
+- doc/AgentSkillParser/Frontmatter.md
+- doc/AgentSkillParser/FrontmatterParser.md
+- doc/AgentSkillParser/Parser.md
+- doc/AgentSkillParser/Skill.md
+- doc/AgentSkillParser/Validator.md
+- doc/index.csv
 - lib/agent_skill_parser.rb
 - lib/agent_skill_parser/allowed_tool.rb
 - lib/agent_skill_parser/allowed_tools_parser.rb
@@ -53,6 +68,7 @@ files:
 - lib/agent_skill_parser/skill.rb
 - lib/agent_skill_parser/validator.rb
 - lib/agent_skill_parser/version.rb
+- llm.txt
 - sig/agent_skill_parser.rbs
 homepage: https://github.com/lucianghinda/agent_skill_parser
 licenses:
@@ -69,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="