Reserved Pass-Through Fields GitHub issue

• • Overview
• • vibecode
• • Structure
• • Example
• • Where It Applies
• • Remote Classes
• • In Caspian: %documentation and %vibecode
• • Pass-Through
• • misc
• • corporate

Overview GitHub issue

{"vibecode": {
    "section": "overview",
    "role": "introduces the reserved pass-through fields in all Puckverse JSON objects",
    "key_concepts": ["vibecode", "comment", "misc", "corporate", "class", "bucket",
        "pass-through", "always_present"]
}}

The Puckverse reserves six keys in every JSON hash: vibecode, comment, misc, corporate, class, and bucket. All six travel silently with any object — passed through transparently by engines, firewalls, and network transport without being stripped, validated, or modified. An object's schema does not need to declare them; they are always present by convention.

vibecode GitHub issue

vibecode carries AI-readable context alongside the object it describes. Any AI reading the object at any point in the system can find the context it needs.

Structure GitHub issue

vibecode is a free-form hash. There is no required schema. Useful fields include:

Other fields may be added as needed. The structure is intentionally open.

Example GitHub issue

{
    "foo": "class",
    "bar": "invoice",

    "vibecode": {
        "purpose": "Represents a customer invoice.",
        "ai_notes": [
            "Do not treat paid invoices as editable.",
            "Line totals should be derived from line items.",
            "Use the object's methods instead of recalculating taxes externally."
        ],
        "related_objects": [
            "customer",
            "payment",
            "invoice_line"
        ]
    }
}

Where It Applies GitHub issue

vibecode can appear in any JSON hash in the Puckverse — any object, anywhere:

• Class definitions
• Individual methods and properties within a class
• Records
• Q0 queries
• Caspian functions
• Mikobase configurations
• Firewall rules

There is no object too small to carry vibecode.

Remote Classes GitHub issue

vibecode is especially valuable on remote classes. When an AI is asked to instantiate a class from borg.com/person and do something with it, it downloads the class definition — which includes the method stubs, local Caspian, and all vibecode. The AI gets everything it needs to use the class correctly in a single download, with no external documentation required.

This means a developer who writes good vibecode on their class is writing instructions for any AI that will ever use it — including AIs they will never meet. The ecosystem creates a natural incentive: if you want AIs to use your remote class correctly, write good vibecode.

In Caspian: %documentation and %vibecode GitHub issue

In addition to the %documentation feature, Caspian also has a %vibecode method:

%vibecode <<EOF
{"purpose":"..."}
EOF

Pass-Through GitHub issue

All six reserved fields (vibecode, comment, misc, corporate, class, bucket) are always passed through. Engines, firewalls, and network transport do not strip or modify them.

misc GitHub issue

misc is a free-rider field for informal, ad hoc use. It has no defined schema and no governance — any system or developer can put whatever they need there. Over time, misc tends to accumulate a hodgepodge of conflicting conventions from different teams and systems. That is expected and acceptable; it is what misc is for.

{
    "foo": "bar",
    "misc": {
        "internal_tracking_id": "abc-123",
        "legacy_system_ref": "old-format-id"
    }
}

corporate GitHub issue

corporate fills the same pass-through role as misc, but is reserved for formally defined standards. Content in corporate should follow agreed-upon schemas or namespacing conventions so that different systems can rely on what they find there.

{
    "foo": "bar",
    "corporate": {
        "acme.com/audit": {
            "created_by": "picard",
            "approved_by": "riker"
        }
    }
}