Skip to content

feat: Add Claude Skills for Osiris component development#61

Merged
padak merged 1 commit into
mainfrom
feature/claude-skills-component-developer
Nov 7, 2025
Merged

feat: Add Claude Skills for Osiris component development#61
padak merged 1 commit into
mainfrom
feature/claude-skills-component-developer

Conversation

@padak

@padak padak commented Nov 7, 2025

Copy link
Copy Markdown
Member

Summary

Add comprehensive Claude Skills infrastructure that enables third-party developers to build production-ready Osiris components in isolated projects.

What's New

Claude Skills

osiris-component-developer - Complete skill for building Osiris components:

  • ✅ SKILL.md with YAML frontmatter and workflow
  • ✅ CHECKLIST.md with 57 validation rules
  • ✅ POSTHOG_EXAMPLE.md with complete working example
  • ✅ TEMPLATES.md with code patterns
  • ✅ README.md with skill documentation

codex - Skill for multi-model validation:

  • ✅ Leverages OpenAI Codex CLI for second opinions
  • ✅ Supports structured JSON output with schemas

Documentation

Component Capabilities:

  • docs/reference/COMPONENT_CAPABILITIES_DEEP_DIVE.md (1,727 lines)
  • docs/reference/COMPONENT_CAPABILITIES_SUMMARY.md (quick reference)
  • docs/reference/COMPONENTS_INDEX.md (navigation)

Third-Party Packaging:

  • Complete packaging strategy and guides (7 documents)
  • Implementation guide, examples, quick reference

Architecture

Follows Claude Skills best practices:

  • ✅ YAML frontmatter (name + description)
  • ✅ Progressive disclosure (Level 1/2/3)
  • ✅ Skill-specific directories with SKILL.md
  • ✅ Resource files for on-demand loading

Total: 18 files, ~10k lines

Benefits

  • 🚀 Third-party developers can build components in separate repos
  • ✅ 57-rule validation ensures quality
  • ☁️ Full E2B cloud compatibility
  • 🔒 Security best practices (x-connection-fields, secret masking)
  • 📦 Standard packaging (Python wheel or tarball)

How to Use

In any Claude Code instance (including separate projects):

User: "Help me create a PostHog extractor for Osiris"
Claude: [Automatically loads osiris-component-developer skill]
        [Guides through component creation with 57-rule validation]

Testing

Skills are validated:

  • ✅ YAML frontmatter syntax
  • ✅ Field limits (name ≤ 64 chars, description ≤ 1024 chars)
  • ✅ No reserved words
  • ✅ Progressive disclosure structure
  • ✅ Test component created and validated in testing_env/posthog-test/

Files Changed

  • .claude/skills/ - 7 new skill files
  • docs/reference/ - 3 new capability docs
  • docs/third-party-packaging/ - 7 new packaging docs
  • .gitignore - Updated

🤖 Generated with Claude Code

Add comprehensive Claude Skills infrastructure for third-party component development:

Skills:
- osiris-component-developer: Complete skill for building Osiris components
  - SKILL.md: Main skill with YAML frontmatter and workflow
  - CHECKLIST.md: 57 validation rules
  - POSTHOG_EXAMPLE.md: Complete PostHog extractor example
  - TEMPLATES.md: Code templates and common patterns
  - README.md: Skill documentation

- codex: Skill for leveraging OpenAI Codex CLI for second opinions
  - Supports multi-model validation and structured JSON output

Documentation:
- docs/reference/COMPONENT_CAPABILITIES_*.md: Component capabilities deep dive
- docs/third-party-packaging/*: Complete packaging strategy and guides

Structure follows Claude Skills best practices:
- YAML frontmatter with name and description
- Progressive disclosure (Level 1/2/3 loading)
- Skill-specific directories with SKILL.md
- Resource files for on-demand loading

Enables third-party developers to build production-ready Osiris components
in isolated projects with full E2B cloud compatibility and 57-rule validation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@padak padak merged commit 57b9c5d into main Nov 7, 2025
1 check passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +76 to +82
modes:
- extract # or write, transform, discover

capabilities:
- discover
- healthcheck

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Documented capabilities format mismatches component schema

The skill’s spec template shows capabilities as a list of strings including a healthcheck entry, but the component schema used by components.registry expects an object of boolean flags (e.g., {discover: true, doctor: true}) and uses doctor as the health check capability. Following this doc will generate specs that fail validation and won’t be recognized by the CLI. Consider documenting the object format and rename the capability to the existing doctor flag.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant