docs(skill): add skill YAML schema and examples #281

New issue

Closed

opened 2026-02-22 23:40:52 +00:00 by freemo · 1 comment

freemo commented

2026-02-22 23:40:52 +00:00

Owner

Metadata

Commit: docs(skill): add skill YAML schema and examples
Branch: feature/m3-skill-schema

Subtasks

Author docs/schema/skill.schema.yaml with versioning, tool refs, inline tools, and include rules.
Add skill examples under examples/skills/ (single-tool, composed, inline tool, validation-only, MCP-backed).
Add schema loader in src/cleveragents/skills/schema.py with validation and clear errors.
Tests (Behave): Add features/skill_schema.feature scenarios validating examples and invalid cases.
Tests (Robot): Add robot/skill_schema.robot to load and validate every example.
Tests (ASV): Add benchmarks/skill_schema_bench.py for schema validation throughput.
Run nox (all default sessions, including benchmark), fix any errors if needed ensuring nox passes.
Verify coverage >=97% via nox -s coverage_report. If coverage is <97% then review the current unit test coverage report at build/coverage.xml and use it to write new Behave based unit tests to improve code coverage. Specifically, write Behave style unit tests that are descriptively named and specifically improves coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun nox -s coverage_report to verify all tests pass and coverage is above >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%.

Section: ### Section 5: Actors, Skills & Tool Execution [WORKSTREAM C - Aditya Lead]
Status: Completed

## Metadata - **Commit**: `docs(skill): add skill YAML schema and examples` - **Branch**: `feature/m3-skill-schema` ## Subtasks - [x] Author `docs/schema/skill.schema.yaml` with versioning, tool refs, inline tools, and include rules. - [x] Add skill examples under `examples/skills/` (single-tool, composed, inline tool, validation-only, MCP-backed). - [x] Add schema loader in `src/cleveragents/skills/schema.py` with validation and clear errors. - [x] Tests (Behave): Add `features/skill_schema.feature` scenarios validating examples and invalid cases. - [x] Tests (Robot): Add `robot/skill_schema.robot` to load and validate every example. - [x] Tests (ASV): Add `benchmarks/skill_schema_bench.py` for schema validation throughput. - [x] Run `nox` (all default sessions, including benchmark), fix any errors if needed ensuring nox passes. - [x] Verify coverage >=97% via `nox -s coverage_report`. If coverage is <97% then review the current unit test coverage report at `build/coverage.xml` and use it to write new Behave based unit tests to improve code coverage. Specifically, write Behave style unit tests that are descriptively named and specifically improves coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `nox -s coverage_report` to verify all tests pass and coverage is above >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%. **Section**: ### Section 5: Actors, Skills & Tool Execution [WORKSTREAM C - Aditya Lead] **Status**: Completed

freemo added this to the v3.1.0 milestone

2026-02-22 23:40:52 +00:00

freemo added the

labels

2026-02-22 23:40:52 +00:00

aditya was assigned by freemo

2026-02-22 23:40:52 +00:00

freemo closed this issue

2026-02-22 23:40:52 +00:00

freemo added a new dependency

2026-02-22 23:54:16 +00:00

#354 Epic: Actor & Skill Schema + CLI (C0)

freemo referenced this issue from a pull request that will close it,

2026-02-23 17:26:29 +00:00

docs(skill): add skill YAML schema and examples #82

freemo commented

2026-02-24 02:31:35 +00:00

Author

Owner

Implementation Notes — C0.skill.schema: Skill YAML Schema

2026-02-16: C0.skill.schema Complete - Skill YAML Schema + Examples + Loader

Created docs/schema/skill.schema.yaml, 5 example skill YAMLs, SkillConfigSchema Pydantic model with from_yaml()/from_yaml_file() factory methods, camelCase->snake_case normalization, ${ENV_VAR} interpolation.
36 Behave scenarios, 6 Robot smoke tests, 3 ASV benchmarks.

(Migrated from docs/implementation-notes.md)

## Implementation Notes — C0.skill.schema: Skill YAML Schema **2026-02-16**: C0.skill.schema Complete - Skill YAML Schema + Examples + Loader - Created `docs/schema/skill.schema.yaml`, 5 example skill YAMLs, `SkillConfigSchema` Pydantic model with `from_yaml()`/`from_yaml_file()` factory methods, camelCase->snake_case normalization, `${ENV_VAR}` interpolation. - 36 Behave scenarios, 6 Robot smoke tests, 3 ASV benchmarks. *(Migrated from `docs/implementation-notes.md`)*