Skill docs: document configSchema inline requirement and .describe() constraints for vault extensions
Opened by swampadmin · 12/8/2025
Problem
The swamp-vault skill (user-defined-vaults.md) does not document two constraints that cause vault extension authors to silently get no field descriptions on swamp.club:
configSchemamust be defined inline in the vault export — the swamp.club extractor looks forconfigSchema: z.object({in the source. If an author defines it as a separateconstand uses shorthand in the export (which is natural TypeScript), neither the "configurable" badge nor any field descriptions will appear..describe()calls must be single-line — the field extractor uses a line-based regex (.*?) that does not match across newlines. Multiline.describe()calls (whichdeno fmtproduces for long strings) result in no description being extracted. Description strings must also avoid commas and quotes as these break the parser.
The HashiCorp Vault example in the skill already uses multiline .describe() which won't be extracted.
Suggested fix
Add notes to the Key Rules section of user-defined-vaults.md documenting:
configSchemamust be inline in the vault export object.describe()must be on a single line per field- Use
vault.configSchemainsidecreateProviderwhen the schema is inline
Related: systeminit/swamp-club#282 — tracking a fix to make the extractor more forgiving so these constraints are not needed.
Closed
No activity in this phase yet.
Sign in to post a ripple.