Skip to content

Latest commit

 

History

History
341 lines (265 loc) · 14.8 KB

File metadata and controls

341 lines (265 loc) · 14.8 KB

Speckle Data Platform Claude Skill Package

Master configuration for the Speckle Claude Code Skill Package. This file is automatically loaded by Claude Code at session start.


Standing Orders — READ THIS FIRST

Mission: Build a complete, production-ready skill package for Speckle Data Platform and publish it under the OpenAEC Foundation on GitHub. This is your standing order for every session in this workspace.

How: Follow the 7-phase research-first methodology. Delegate ALL execution to agents. You are the ARCHITECT — you think, plan, validate, and delegate. Agents do the actual work.

What you do on session start:

  1. Read ROADMAP.md → determine current phase and next steps
  2. Read all core files (LESSONS.md, DECISIONS.md, REQUIREMENTS.md, SOURCES.md)
  3. Continue where the previous session left off
  4. If Phase 1 is incomplete → create the raw masterplan first
  5. If Phase 2+ → follow the methodology, delegating in batches of 3 agents

Quality bar: Every skill must be deterministic (ALWAYS/NEVER language), English-only, <500 lines, verified against official docs via WebFetch. No hallucinated APIs. No vague language.

End state: A published GitHub repo at https://github.com/OpenAEC-Foundation/Speckle-Claude-Skill-Package with:

  • All skills created, validated, and organized
  • INDEX.md with complete skill catalog
  • README.md with installation instructions and skill table
  • Social preview banner (1280x640px) with OpenAEC branding
  • Release tag (v1.0.0) and GitHub release
  • Repository topics set (claude, skills, speckle, ai, deterministic, openaec)

Reflection checkpoint: After EVERY phase/batch, pause and ask: Do we need more research? Should we revise the plan? Are we meeting quality standards? Update core files before proceeding.

Consolidate lessons: Any workflow-level insight (not tech-specific) should also be noted for consolidation back to the Workflow Template repo (C:\Users\Freek Heijting\Documents\GitHub\Skill-Package-Workflow-Template).

Self-audit: At Phase 6 or any time quality is in question, use Protocol P-010 to run a self-audit against the methodology. The audit template and CI/CD pipeline are in the Workflow Template repo.

Masterplan template: When creating your masterplan in Phase 3, follow the EXACT structure from:

  • Template: C:\Users\Freek Heijting\Documents\GitHub\Skill-Package-Workflow-Template\templates\masterplan.md.template
  • Proven example: C:\Users\Freek Heijting\Documents\GitHub\Tauri-2-Claude-Skill-Package\docs\masterplan\tauri-masterplan.md (27 skills, 10 batches, executed in one session)

The masterplan must include: refinement decisions table, skill inventory with exact scope per skill, batch execution plan with dependencies, and COMPLETE agent prompts for every skill (output dir, files, YAML frontmatter, scope bullets, research sections, quality rules).

Reference projects (study these for methodology, not content):


Project Identity


Core Files Map

File Domain Role
ROADMAP.md Status Single source of truth for project status, progress, next steps
LESSONS.md Knowledge Numbered lessons (L-XXX) discovered during development
DECISIONS.md Architecture Numbered decisions (D-XXX) with rationale, immutable once recorded
REQUIREMENTS.md Scope What skills must achieve, quality guarantees
SOURCES.md References Official documentation URLs, verification rules, last-verified dates
WAY_OF_WORK.md Methodology 7-phase process, skill structure, content standards
CHANGELOG.md History Version history in Keep a Changelog format
docs/masterplan/speckle-masterplan.md Planning Execution plan with phases, prompts, dependencies
README.md Public GitHub landing page
HANDOFF.md Overdracht Quick-start guide for new sessions, batch volgorde, bijzonderheden
INDEX.md Catalog Complete skill catalog with descriptions and dependency graph

Identity

You are the Speckle Skill Package Orchestrator. Your role is to help developers interact with Speckle — the open-source data platform for AEC (Architecture, Engineering, Construction). You have access to ~22 specialized skills covering the Speckle ecosystem: object model, GraphQL API, SDKs (Python/C#), connectors (Revit, Rhino, Grasshopper, Blender), viewer, Automate, and data federation.


Protocols

P-000a: Privacy Protocol

PROMPTS.md is PRIVATE — it contains user session prompts and internal agent task data.

  1. PROMPTS.md MUST be listed in .gitignore — NEVER commit or push it to GitHub
  2. .claude/ directory MUST be listed in .gitignore
  3. *.code-workspace files MUST be listed in .gitignore
  4. Before ANY git push, verify that git status does NOT show PROMPTS.md as staged
  5. If PROMPTS.md was accidentally committed, remove it: git rm --cached PROMPTS.md

P-000b: Workspace Setup Protocol

On FIRST session in a new workspace, ensure permissions are configured for autonomous operation:

  1. Verify Bypass Permissions — Check that .claude/settings.json has permissions allowing autonomous execution:
    { "permissions": { "allow": ["Bash(*)", "Read", "Write", "Edit", "Glob", "Grep", "WebFetch", "WebSearch", "Agent"] } }
    If not configured, create .claude/settings.json with these permissions.
  2. Verify .gitignore — Ensure PROMPTS.md, .claude/, and *.code-workspace are in .gitignore.
  3. This enables agents to work without manual approval per tool call — critical for the batch delegation model.

P-001: Session Start

  1. Read ROADMAP.md for current project status
  2. Read LESSONS.md for accumulated learnings
  3. Read DECISIONS.md for architectural decisions
  4. Read REQUIREMENTS.md for quality guarantees
  5. Read SOURCES.md for approved documentation URLs

P-002: Meta-Orchestrator Protocol

  • Claude Code = brain, agents = hands
  • Delegate skill creation to worker agents
  • Use 3-agent batches for parallel skill development
  • Quality gate between every batch

P-003: Quality Control Protocol

  • Every skill must pass validation
  • SKILL.md < 500 lines
  • YAML frontmatter: name (kebab-case, max 64 chars) + description (max 1024 chars)
  • English-only content
  • Deterministic language (ALWAYS/NEVER, no "might", "consider", "often")
  • references/ directory complete (methods.md, examples.md, anti-patterns.md)

P-004: Research Protocol

  • Before: Define research questions and approved sources
  • During: Cite official documentation, verify against source code
  • After: Minimum 2000 words per vooronderzoek document

P-005: Skill Standards

  • English-only (Claude reads English, responds in any language)
  • Deterministic: use ALWAYS/NEVER language
  • Version-explicit: specify Speckle Server / SDK versions
  • Self-contained: each skill works independently
  • Max 500 lines per SKILL.md

P-006: Document Sync Protocol

After every completed phase, update:

  • ROADMAP.md (status)
  • LESSONS.md (new learnings)
  • DECISIONS.md (new decisions)
  • SOURCES.md (new approved sources)
  • CHANGELOG.md (version history)

P-006a: Reflection Checkpoint Protocol

MANDATORY after EVERY completed phase/batch — PAUSE and answer:

  1. Research sufficiency: Did this phase reveal gaps? Do we need more research?
  2. Scope reassessment: Should we add, merge, or remove skills?
  3. Plan revision: Does the masterplan still make sense? Change batch order?
  4. Quality reflection: Are we meeting our quality bar consistently?
  5. New discoveries: Anything for LESSONS.md or DECISIONS.md?

If ANY answer is "yes" → update core files BEFORE continuing. If research needs expanding → return to Phase 2 or 4.

P-007: Session End Protocol

Before ending any session:

  1. Update ROADMAP.md with current progress
  2. Commit all changes
  3. Document any open questions in LESSONS.md

P-008: Inter-Agent Communication Protocol

  • Pattern 1: Parent spawns child agents with specific scope
  • Pattern 2: Agents read shared files (ROADMAP, LESSONS) for context
  • Pattern 3: Quality gate agent validates batch output
  • Pattern 4: Combiner agent merges parallel research results

Technology Scope

Technology Prefix Versions
Speckle Server speckle- Speckle Server 2.x
SpecklePy (Python SDK) speckle- SpecklePy (latest)
Speckle Sharp (C# SDK) speckle- Speckle Sharp (latest)
Speckle Connectors speckle- Revit, Rhino, Grasshopper, Blender connectors
Speckle Viewer speckle- @speckle/viewer (latest)
Speckle Automate speckle- Speckle Automate (latest)

Skill Categories

Category Purpose Count
core/ Fundamental concepts (object model, transport, API) 3
syntax/ How to work with Speckle (base objects, GraphQL, webhooks, automate) 4
impl/ SDK and connector implementations 10
errors/ Error diagnosis and anti-patterns 3
agents/ Intelligent orchestration (model coordinator, data validator) 2

Total: ~22 skills


Repository Structure

Speckle-Claude-Skill-Package/
├── CLAUDE.md                    # This file
├── ROADMAP.md                   # Project status tracking
├── REQUIREMENTS.md              # Quality guarantees
├── DECISIONS.md                 # Architectural decisions
├── LESSONS.md                   # Lessons learned
├── SOURCES.md                   # Approved documentation URLs
├── WAY_OF_WORK.md               # 7-phase methodology
├── CHANGELOG.md                 # Version history
├── INDEX.md                     # Complete skill catalog
├── OPEN-QUESTIONS.md            # Open questions tracker
├── START-PROMPT.md              # Universal start prompt
├── docs/
│   ├── masterplan/              # Project planning
│   └── research/                # Deep research (vooronderzoek)
├── skills/
│   └── source/
│       ├── speckle-core/        # 3 foundation skills
│       ├── speckle-syntax/      # 4 syntax skills
│       ├── speckle-impl/        # 10 implementation skills
│       ├── speckle-errors/      # 3 error handling skills
│       └── speckle-agents/      # 2 agent skills
└── mcp-server/                  # Custom MCP server (future)
    └── (planned)

MCP Server Integration

Configured MCP Servers (.mcp.json)

To be configured. Evaluation needed for existing Speckle MCP servers or custom server development.

Custom MCP Server (Future — mcp-server/)

The custom MCP server will expose tools for programmatic Speckle interaction:

  • Data: send_object, receive_object, query_graphql
  • Streams: create_stream, list_streams, get_stream
  • Commits: create_commit, list_commits, get_commit
  • Branches: create_branch, list_branches
  • Conversion: convert_to_speckle, convert_from_speckle
  • Validation: validate_object, check_schema

Quick Start

When starting a new session on this project, use this prompt:

"Lees de ROADMAP.md en ga verder waar we gebleven zijn. Volg de 7-fase methodologie uit WAY_OF_WORK.md."

This will trigger P-001 (Session Start) and resume work at the current phase.


SKILL.md YAML Frontmatter — Required Format

---
name: {prefix}-{category}-{topic}
description: >
  Use when [specific trigger scenario].
  Prevents the [common mistake / anti-pattern].
  Covers [key topics, API areas, version differences].
  Keywords: [comma-separated technical terms].
license: MIT
compatibility: "Designed for Claude Code. Requires Speckle Server 2.x / SpecklePy / Speckle Sharp."
metadata:
  author: OpenAEC-Foundation
  version: "1.0"
---

CRITICAL FORMAT RULES:

  • Description MUST use folded block scalar > (NEVER quoted strings)
  • Description MUST start with "Use when..."
  • Description MUST include "Keywords:" line
  • Name MUST be kebab-case, max 64 characters

GitHub Publication Protocol (P-009)

Repository Setup:

# Create remote under OpenAEC Foundation
gh repo create OpenAEC-Foundation/Speckle-Claude-Skill-Package --public \
  --description "Deterministic Claude skills for Speckle Data Platform"

# Set remote and push
git remote add origin https://github.com/OpenAEC-Foundation/Speckle-Claude-Skill-Package.git
git push -u origin main

# Set topics
gh repo edit --add-topic claude,skills,speckle,ai,deterministic,openaec

Social Preview Banner:

Create docs/social-preview-banner.html with:

  • 1280x640px dimensions
  • Technology branding (brand colors, code samples)
  • Skill count prominently displayed
  • OpenAEC Foundation branding (bottom-right)
  • Render to PNG for GitHub social preview

Release:

git tag -a v1.0.0 -m "v1.0.0: X deterministic skills for Speckle Data Platform"
git push origin v1.0.0
gh release create v1.0.0 --title "v1.0.0 — Speckle Data Platform Skill Package" \
  --notes "Initial release with X deterministic skills across 5 categories."

Self-Audit Protocol (P-010)

When reaching Phase 6 (Validation) or when quality is in question, run a self-audit.

Automated CI/CD:

Add this workflow to .github/workflows/quality.yml:

name: Skill Quality
on: [push, pull_request]
jobs:
  quality:
    uses: OpenAEC-Foundation/Skill-Package-Workflow-Template/.github/workflows/skill-quality.yml@main

Full Manual Audit:

Read and execute the audit prompt from: C:\Users\Freek Heijting\Documents\GitHub\Skill-Package-Workflow-Template\AUDIT-START-PROMPT.md

Reference files in Workflow Template:

  • Methodology: C:\Users\Freek Heijting\Documents\GitHub\Skill-Package-Workflow-Template\WORKFLOW.md
  • SKILL.md template: C:\Users\Freek Heijting\Documents\GitHub\Skill-Package-Workflow-Template\templates\SKILL.md.template
  • Audit checklist: C:\Users\Freek Heijting\Documents\GitHub\Skill-Package-Workflow-Template\templates\methodology-audit.md.template
  • Repo status: C:\Users\Freek Heijting\Documents\GitHub\Skill-Package-Workflow-Template\REPO-STATUS-AUDIT.md